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

annotate babel/messages/catalog.py @ 167:533baef258bb

Implement fuzzy matching to catalog updates. No frontend yet.

author	cmlenz
date	Fri, 22 Jun 2007 08:39:04 +0000
parents	eafaa302dde1
children	47f6c31e9a24

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):
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	69 return '<%s %r>' % (type(self).__name__, 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	70
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	71 def fuzzy(self):
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	72 return 'fuzzy' in self.flags
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	73 fuzzy = property(fuzzy, doc="""\
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	74 Whether the translation is fuzzy.
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	75
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	76 >>> Message('foo').fuzzy
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	77 False
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	78 >>> Message('foo', 'foo', flags=['fuzzy']).fuzzy
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	79 True
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	80
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	81 :type: `bool`
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	82 """)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	83
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	84 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	85 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	86 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	87 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	88
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 >>> 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	90 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	91 >>> 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	92 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	93
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	94 :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	95 """)
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
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 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	98 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	99 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	100 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	101 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	102 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	103 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	104
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 >>> 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	106 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	107 >>> 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	108 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	109
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	110 :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	111 """)
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
107 4b42e23644e5 `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 106 diff changeset	113
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	114 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	115 # Translations template for PROJECT.
122 03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	116 # 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	117 # 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	118 # 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	119 #"""
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	120
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	121 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	122 """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	123
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	124 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	125 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	126 msgid_bugs_address=None, creation_date=None,
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 revision_date=None, last_translator=None, charset='utf-8'):
66 d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	128 """Initialize the catalog object.
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	129
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	130 :param locale: the locale identifier or `Locale` object, or `None`
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	131 if the catalog is not bound to a locale (which basically
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	132 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	133 :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	134 :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	135 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	136 :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	137 :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	138 :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	139 :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	140 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	141 :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	142 :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	143 :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	144 :param charset: the encoding to use in the output
66 d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	145 """
109 7a5a7bf39d3d Minor doc improvements. cmlenz parents: 108 diff changeset	146 self.domain = domain #: The message domain
66 d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	147 if locale:
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	148 locale = Locale.parse(locale)
109 7a5a7bf39d3d Minor doc improvements. cmlenz parents: 108 diff changeset	149 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	150 self._header_comment = header_comment
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	151 self._messages = odict()
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	152
109 7a5a7bf39d3d Minor doc improvements. cmlenz parents: 108 diff changeset	153 self.project = project or 'PROJECT' #: The project name
7a5a7bf39d3d Minor doc improvements. cmlenz parents: 108 diff changeset	154 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	155 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	156 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	157
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 107 diff changeset	158 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	159 """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	160
97 debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT). cmlenz parents: 89 diff changeset	161 self.charset = charset or 'utf-8'
86 8a703ecdba91 Some cosmetic changes for the new translator comments support. cmlenz parents: 82 diff changeset	162
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	163 if creation_date is None:
99 b6b5992daa6c Renamed `LOCAL` to `LOCALTZ`. cmlenz parents: 97 diff changeset	164 creation_date = datetime.now(LOCALTZ)
97 debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT). cmlenz parents: 89 diff changeset	165 elif isinstance(creation_date, datetime) and not creation_date.tzinfo:
99 b6b5992daa6c Renamed `LOCAL` to `LOCALTZ`. cmlenz parents: 97 diff changeset	166 creation_date = creation_date.replace(tzinfo=LOCALTZ)
109 7a5a7bf39d3d Minor doc improvements. cmlenz parents: 108 diff changeset	167 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	168 if revision_date is None:
99 b6b5992daa6c Renamed `LOCAL` to `LOCALTZ`. cmlenz parents: 97 diff changeset	169 revision_date = datetime.now(LOCALTZ)
97 debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT). cmlenz parents: 89 diff changeset	170 elif isinstance(revision_date, datetime) and not revision_date.tzinfo:
99 b6b5992daa6c Renamed `LOCAL` to `LOCALTZ`. cmlenz parents: 97 diff changeset	171 revision_date = revision_date.replace(tzinfo=LOCALTZ)
109 7a5a7bf39d3d Minor doc improvements. cmlenz parents: 108 diff changeset	172 self.revision_date = revision_date #: Last revision date of the catalog
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	173
109 7a5a7bf39d3d Minor doc improvements. cmlenz parents: 108 diff changeset	174 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	175 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	176 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	177 .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	178 .replace('YEAR', self.revision_date.strftime('%Y')) \
122 03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	179 .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	180 if self.locale:
109 7a5a7bf39d3d Minor doc improvements. cmlenz parents: 108 diff changeset	181 comment = comment.replace('Translations template', '%s translations'
7a5a7bf39d3d Minor doc improvements. cmlenz parents: 108 diff changeset	182 % 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	183 return comment
122 03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	184
109 7a5a7bf39d3d Minor doc improvements. cmlenz parents: 108 diff changeset	185 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	186 self._header_comment = string
109 7a5a7bf39d3d Minor doc improvements. cmlenz parents: 108 diff changeset	187
7a5a7bf39d3d Minor doc improvements. cmlenz parents: 108 diff changeset	188 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	189 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	190
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	191 >>> 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	192 ... 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	193 >>> 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	194 # 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	195 # 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	196 # 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	197 # 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	198 #
108 8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 107 diff changeset	199
122 03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	200 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	201 will be replaced when the header is retrieved again:
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	202
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	203 >>> catalog = Catalog(project='Foobar', version='1.0',
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	204 ... copyright_holder='Foo Company')
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	205 >>> catalog.header_comment = '''\\
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	206 ... # The POT for my really cool PROJECT project.
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	207 ... # Copyright (C) 1990-2003 ORGANIZATION
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	208 ... # This file is distributed under the same license as the PROJECT
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	209 ... # project.
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	210 ... #'''
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	211 >>> print catalog.header_comment
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	212 # The POT for my really cool Foobar project.
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	213 # Copyright (C) 1990-2003 Foo Company
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	214 # This file is distributed under the same license as the Foobar
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	215 # project.
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	216 #
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	217
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	218 :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	219 """)
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	220
108 8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 107 diff changeset	221 def _get_mime_headers(self):
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	222 headers = []
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	223 headers.append(('Project-Id-Version',
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	224 '%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	225 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	226 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	227 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	228 locale='en')))
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	229 if self.locale is None:
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	230 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	231 headers.append(('Last-Translator', 'FULL NAME <EMAIL@ADDRESS>'))
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	232 headers.append(('Language-Team', 'LANGUAGE <LL@li.org>'))
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	233 else:
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	234 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	235 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	236 'yyyy-MM-dd HH:mmZ', locale='en')))
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	237 headers.append(('Last-Translator', self.last_translator))
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	238 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	239 headers.append(('Plural-Forms', self.plural_forms))
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	240 headers.append(('MIME-Version', '1.0'))
70 620fdd25657a Add back POT header broken in previous check-in. cmlenz parents: 69 diff changeset	241 headers.append(('Content-Type',
620fdd25657a Add back POT header broken in previous check-in. cmlenz parents: 69 diff changeset	242 'text/plain; charset=%s' % self.charset))
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	243 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	244 headers.append(('Generated-By', 'Babel %s\n' % VERSION))
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	245 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	246
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 107 diff changeset	247 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	248 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	249 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	250 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	251 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	252 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	253 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	254 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	255 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	256 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	257 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	258 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	259 # 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	260 # is ready
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 107 diff changeset	261 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	262 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	263 ts = time.mktime(tt)
122 03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	264 tzoffset = FixedOffsetTimezone(int(tzoffset[:2]) * 60 +
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	265 int(tzoffset[2:]))
123 5b4f302abf53 Fix parsing of timezone in POT creation date. cmlenz parents: 122 diff changeset	266 dt = datetime.fromtimestamp(ts)
5b4f302abf53 Fix parsing of timezone in POT creation date. cmlenz parents: 122 diff changeset	267 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	268 elif name == 'content-type':
12e5f21dfcda Respect charset specified in PO headers in `read_po()`. Fixes #17. cmlenz parents: 133 diff changeset	269 mimetype, params = parse_header(value)
12e5f21dfcda Respect charset specified in PO headers in `read_po()`. Fixes #17. cmlenz parents: 133 diff changeset	270 if 'charset' in params:
12e5f21dfcda Respect charset specified in PO headers in `read_po()`. Fixes #17. cmlenz parents: 133 diff changeset	271 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	272
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 107 diff changeset	273 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	274 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	275
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	276 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	277 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	278 for actual translations.
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	279
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	280 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	281
97 debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT). cmlenz parents: 89 diff changeset	282 >>> created = datetime(1990, 4, 1, 15, 30, tzinfo=UTC)
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	283 >>> 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	284 ... 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	285 >>> for name, value in catalog.mime_headers:
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	286 ... print '%s: %s' % (name, value)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	287 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	288 Report-Msgid-Bugs-To: EMAIL@ADDRESS
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	289 POT-Creation-Date: 1990-04-01 15:30+0000
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	290 PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	291 Last-Translator: FULL NAME <EMAIL@ADDRESS>
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	292 Language-Team: LANGUAGE <LL@li.org>
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	293 MIME-Version: 1.0
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	294 Content-Type: text/plain; charset=utf-8
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	295 Content-Transfer-Encoding: 8bit
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	296 Generated-By: Babel ...
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	297
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	298 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	299
97 debd9ac3bb4d Fix for #11 (use local timezone in timestamps of generated POT). cmlenz parents: 89 diff changeset	300 >>> revised = datetime(1990, 8, 3, 12, 0, tzinfo=UTC)
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	301 >>> 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	302 ... creation_date=created, revision_date=revised,
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	303 ... 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	304 >>> for name, value in catalog.mime_headers:
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	305 ... print '%s: %s' % (name, value)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	306 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	307 Report-Msgid-Bugs-To: EMAIL@ADDRESS
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	308 POT-Creation-Date: 1990-04-01 15:30+0000
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	309 PO-Revision-Date: 1990-08-03 12:00+0000
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	310 Last-Translator: John Doe <jd@example.com>
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	311 Language-Team: de_DE <LL@li.org>
86 8a703ecdba91 Some cosmetic changes for the new translator comments support. cmlenz parents: 82 diff changeset	312 Plural-Forms: nplurals=2; plural=(n != 1)
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	313 MIME-Version: 1.0
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	314 Content-Type: text/plain; charset=utf-8
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	315 Content-Transfer-Encoding: 8bit
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	316 Generated-By: Babel ...
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	317
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	318 :type: `list`
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	319 """)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	320
70 620fdd25657a Add back POT header broken in previous check-in. cmlenz parents: 69 diff changeset	321 def num_plurals(self):
620fdd25657a Add back POT header broken in previous check-in. cmlenz parents: 69 diff changeset	322 num = 2
620fdd25657a Add back POT header broken in previous check-in. cmlenz parents: 69 diff changeset	323 if self.locale:
620fdd25657a Add back POT header broken in previous check-in. cmlenz parents: 69 diff changeset	324 if str(self.locale) in PLURALS:
620fdd25657a Add back POT header broken in previous check-in. cmlenz parents: 69 diff changeset	325 num = PLURALS[str(self.locale)][0]
620fdd25657a Add back POT header broken in previous check-in. cmlenz parents: 69 diff changeset	326 elif self.locale.language in PLURALS:
620fdd25657a Add back POT header broken in previous check-in. cmlenz parents: 69 diff changeset	327 num = PLURALS[self.locale.language][0]
620fdd25657a Add back POT header broken in previous check-in. cmlenz parents: 69 diff changeset	328 return num
86 8a703ecdba91 Some cosmetic changes for the new translator comments support. cmlenz parents: 82 diff changeset	329 num_plurals = property(num_plurals, doc="""\
8a703ecdba91 Some cosmetic changes for the new translator comments support. cmlenz parents: 82 diff changeset	330 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	331
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 99 diff changeset	332 >>> Catalog(locale='en').num_plurals
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 99 diff changeset	333 2
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 99 diff changeset	334 >>> Catalog(locale='cs_CZ').num_plurals
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 99 diff changeset	335 3
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 99 diff changeset	336
abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 99 diff changeset	337 :type: `int`
86 8a703ecdba91 Some cosmetic changes for the new translator comments support. cmlenz parents: 82 diff changeset	338 """)
70 620fdd25657a Add back POT header broken in previous check-in. cmlenz parents: 69 diff changeset	339
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	340 def plural_forms(self):
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	341 num, expr = ('INTEGER', 'EXPRESSION')
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	342 if self.locale:
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	343 if str(self.locale) in PLURALS:
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	344 num, expr = PLURALS[str(self.locale)]
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	345 elif self.locale.language in PLURALS:
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	346 num, expr = PLURALS[self.locale.language]
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	347 return 'nplurals=%s; plural=%s' % (num, expr)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	348 plural_forms = property(plural_forms, doc="""\
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	349 Return the plural forms declaration for the locale.
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	350
105 abd3a594dab4 Implement wrapping of header comments in PO(T) output. Related to #14. cmlenz parents: 99 diff changeset	351 >>> Catalog(locale='en').plural_forms
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	352 'nplurals=2; plural=(n != 1)'
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	353 >>> Catalog(locale='pt_BR').plural_forms
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	354 'nplurals=2; plural=(n > 1)'
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	355
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	356 :type: `str`
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	357 """)
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	358
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	359 def __contains__(self, id):
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	360 """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	361 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	362
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	363 def __len__(self):
86 8a703ecdba91 Some cosmetic changes for the new translator comments support. cmlenz parents: 82 diff changeset	364 """The number of messages in the catalog.
8a703ecdba91 Some cosmetic changes for the new translator comments support. cmlenz parents: 82 diff changeset	365
8a703ecdba91 Some cosmetic changes for the new translator comments support. cmlenz parents: 82 diff changeset	366 This does not include the special ``msgid ""`` entry.
8a703ecdba91 Some cosmetic changes for the new translator comments support. cmlenz parents: 82 diff changeset	367 """
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	368 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	369
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	370 def __iter__(self):
66 d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	371 """Iterates through all the entries in the catalog, in the order they
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	372 were added, yielding a `Message` object for every entry.
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	373
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	374 :rtype: ``iterator``
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	375 """
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	376 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	377 for name, value in self.mime_headers:
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	378 buf.append('%s: %s' % (name, value))
1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	379 yield Message('', '\n'.join(buf), flags=set(['fuzzy']))
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	380 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	381 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	382
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	383 def __repr__(self):
66 d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	384 locale = ''
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	385 if self.locale:
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	386 locale = ' %s' % self.locale
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	387 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	388
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	389 def __delitem__(self, id):
66 d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	390 """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	391 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	392 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	393 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	394
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	395 def __getitem__(self, id):
66 d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	396 """Return the message with the specified ID.
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	397
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	398 :param id: the message ID
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	399 :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	400 is in the catalog
69 1d8e81bfedf9 Enhance catalog to also manage the MIME headers. cmlenz parents: 66 diff changeset	401 :rtype: `Message`
66 d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	402 """
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	403 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	404
068952b4d4c0 Add actual data structures for handling message catalogs, so that more code can be reused here between the frontends. cmlenz parents: diff changeset	405 def __setitem__(self, id, message):
66 d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	406 """Add or update the message with the specified ID.
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	407
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	408 >>> catalog = Catalog()
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	409 >>> catalog[u'foo'] = Message(u'foo')
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	410 >>> catalog[u'foo']
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	411 <Message u'foo'>
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	412
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	413 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	414 to include the locations and flags of the new message.
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	415
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	416 >>> catalog = Catalog()
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	417 >>> catalog[u'foo'] = Message(u'foo', locations=[('main.py', 1)])
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	418 >>> catalog[u'foo'].locations
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	419 [('main.py', 1)]
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	420 >>> catalog[u'foo'] = Message(u'foo', locations=[('utils.py', 5)])
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	421 >>> catalog[u'foo'].locations
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	422 [('main.py', 1), ('utils.py', 5)]
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	423
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	424 :param id: the message ID
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	425 :param message: the `Message` object
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	426 """
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	427 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	428 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	429 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	430 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	431 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	432 # 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	433 current.id = message.id
72 f5a6bf38df89 Fix for mixed singular/plural messages, follow-up to [70]. cmlenz parents: 71 diff changeset	434 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	435 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	436 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	437 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	438 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	439 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	440 elif id == '':
8ea225f33f28 Fix for #16: the header message (`msgid = ""`) is now treated specially by `read_po` and `Catalog`. cmlenz parents: 107 diff changeset	441 # 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	442 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	443 self.mime_headers = headers.items()
122 03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	444 self.header_comment = '\n'.join(['# %s' % comment for comment
03f106700f02 Added tests for `new_catalog` distutils command. cmlenz parents: 109 diff changeset	445 in 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	446 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	447 if isinstance(id, (list, tuple)):
70 620fdd25657a Add back POT header broken in previous check-in. cmlenz parents: 69 diff changeset	448 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	449 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	450
107 4b42e23644e5 `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 106 diff changeset	451 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	452 user_comments=()):
66 d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	453 """Add or update the message with the specified ID.
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	454
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	455 >>> catalog = Catalog()
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	456 >>> catalog.add(u'foo')
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	457 >>> catalog[u'foo']
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	458 <Message u'foo'>
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	459
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	460 This method simply constructs a `Message` object with the given
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	461 arguments and invokes `__setitem__` with that object.
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	462
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	463 :param id: the message ID, or a ``(singular, plural)`` tuple for
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	464 pluralizable messages
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	465 :param string: the translated message string, or a
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	466 ``(singular, plural)`` tuple for pluralizable messages
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	467 :param locations: a sequence of ``(filenname, lineno)`` tuples
d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	468 :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	469 :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	470 :param user_comments: a sequence of user comments
66 d1a7425739d3 `read_po` now returns a `Catalog`. cmlenz parents: 63 diff changeset	471 """
107 4b42e23644e5 `Message`, `read_po` and `write_po` now all handle user/auto comments correctly. palgarvio parents: 106 diff changeset	472 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	473 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	474
167 533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	475 def update(self, template, fuzzy_matching=True):
165 eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	476 """Update the catalog based on the given template catalog.
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	477
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	478 >>> from babel.messages import Catalog
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	479 >>> template = Catalog()
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	480 >>> template.add('blue', locations=[('main.py', 100)])
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	481 >>> template.add(('salad', 'salads'), locations=[('util.py', 42)])
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	482 >>> catalog = Catalog(locale='de_DE')
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	483 >>> catalog.add('blue', u'blau', locations=[('main.py', 98)])
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	484 >>> catalog.add('head', u'Kopf', locations=[('util.py', 33)])
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	485 >>> catalog.add(('salad', 'salads'), (u'Salat', u'Salate'),
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	486 ... locations=[('util.py', 38)])
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	487
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	488 >>> rest = catalog.update(template)
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	489 >>> len(catalog)
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	490 2
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	491
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	492 >>> msg1 = catalog['blue']
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	493 >>> msg1.string
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	494 u'blau'
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	495 >>> msg1.locations
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	496 [('main.py', 100)]
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	497
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	498 >>> msg2 = catalog['salad']
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	499 >>> msg2.string
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	500 (u'Salat', u'Salate')
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	501 >>> msg2.locations
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	502 [('util.py', 42)]
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	503
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	504 >>> 'head' in catalog
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	505 False
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	506 >>> rest
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	507 [<Message 'head'>]
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	508
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	509 :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	510 :param fuzzy_matching: whether to use fuzzy matching of message IDs
165 eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	511 :return: a list of `Message` objects that the catalog contained before
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	512 the updated, but couldn't be found in the template
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	513 """
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	514 messages = self._messages
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	515 self._messages = odict()
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	516
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	517 for message in template:
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	518 if message.id:
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	519 key = self._key_for(message.id)
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	520 if key in messages:
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	521 oldmsg = messages.pop(key)
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	522 message.string = oldmsg.string
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	523 message.flags \|= oldmsg.flags
eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	524 self[message.id] = message
167 533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	525
165 eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	526 else:
167 533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	527 if fuzzy_matching:
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	528 # do some fuzzy matching with difflib
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	529 matches = get_close_matches(key.lower().strip(),
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	530 [self._key_for(msgid) for msgid in messages], 1)
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	531 if matches:
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	532 oldmsg = messages.pop(matches[0])
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	533 message.string = oldmsg.string
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	534 message.flags \|= oldmsg.flags \| set([u'fuzzy'])
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	535 self[message.id] = message
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	536 continue
165 eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	537
167 533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	538 self[message.id] = message
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	539
533baef258bb Implement fuzzy matching to catalog updates. No frontend yet. cmlenz parents: 165 diff changeset	540 return messages.values()
165 eafaa302dde1 Added preliminary catalog updating/merging functionality. cmlenz parents: 151 diff changeset	541
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	542 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	543 """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	544 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	545 """
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	546 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	547 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	548 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	549 return key

Mercurial > babel > old > mirror

annotate babel/messages/catalog.py @ 167:533baef258bb