##############################################################################
#
# Copyright (c) 2004 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""I18n Messages and factories.
"""
__docformat__ = "reStructuredText"
_marker = object()
[docs]
class Message(str):
"""Message (Python implementation)
This is a string used as a message. It has a domain attribute that is
its source domain, and a default attribute that is its default text to
display when there is no translation. domain may be None meaning there is
no translation domain. default may also be None, in which case the
message id itself implicitly serves as the default text.
"""
__slots__ = (
'domain', 'default', 'mapping', '_readonly',
'msgid_plural', 'default_plural', 'number')
def __new__(cls, ustr, domain=_marker, default=_marker, mapping=_marker,
msgid_plural=_marker, default_plural=_marker, number=_marker):
self = str.__new__(cls, ustr)
if isinstance(ustr, self.__class__):
self.domain = ustr.domain
self.default = ustr.default
self.mapping = ustr.mapping
self.msgid_plural = ustr.msgid_plural
self.default_plural = ustr.default_plural
self.number = ustr.number
else:
self.domain = None
self.default = None
self.mapping = None
self.msgid_plural = None
self.default_plural = None
self.number = None
if domain is not _marker:
self.domain = domain
if default is not _marker:
self.default = default
if mapping is not _marker:
self.mapping = mapping
if msgid_plural is not _marker:
self.msgid_plural = msgid_plural
if default_plural is not _marker:
self.default_plural = default_plural
if number is not _marker:
self.number = number
if self.number is not None and not isinstance(
self.number, (int, float)):
raise TypeError('`number` should be an integer or a float')
self._readonly = True
return self
def __setattr__(self, key, value):
"""Message is immutable
It cannot be changed once the message id is created.
"""
if getattr(self, '_readonly', False):
raise TypeError('readonly attribute')
else:
return str.__setattr__(self, key, value)
def __getstate__(self):
return (
str(self), self.domain, self.default, self.mapping,
self.msgid_plural, self.default_plural, self.number)
def __reduce__(self):
return self.__class__, self.__getstate__()
# Name the fallback Python implementation to make it easier to test.
pyMessage = Message
try:
from ._zope_i18nmessageid_message import Message
except ImportError: # pragma: no cover
pass
[docs]
class MessageFactory:
"""Factory for creating i18n messages."""
def __init__(self, domain):
self._domain = domain
def __call__(self, ustr, default=None, mapping=None,
msgid_plural=None, default_plural=None, number=None):
return Message(ustr, self._domain, default, mapping,
msgid_plural, default_plural, number)