11047648627

Committed 26 Sep 2024 07:32AM UTC coverage: 99.018% (-0.1%) from 99.137%

Build # 11047648627

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #64 from zopefoundation/test_compatibility_i18nmessageid7+

fix test incompatibility for `zope.i18nmessageid >= 7.0`

Run Details

931 of 969 branches covered (96.08%)

Branch coverage included in aggregate %.

4 of 6 new or added lines in 1 file covered. (66.67%)

1 existing line in 1 file now uncovered.

3203 of 3206 relevant lines covered (99.91%)

1.0 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.38

/src/zope/i18n/translationdomain.py

##############################################################################
#
# Copyright (c) 2001-2008 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.
#
##############################################################################
"""Global Translation Service for providing I18n to file-based code.
"""

import zope.component
import zope.interface
from zope.i18nmessageid import Message

from zope.i18n import interpolate
from zope.i18n import translate
from zope.i18n.interfaces import INegotiator
from zope.i18n.interfaces import ITranslationDomain


# The configuration should specify a list of fallback languages for the
# site.  If a particular catalog for a negotiated language is not available,
# then the zcml specified order should be tried.  If that fails, then as a
# last resort the languages in the following list are tried.  If these fail
# too, then the msgid is returned.
#
# Note that these fallbacks are used only to find a catalog.  If a particular
# message in a catalog is not translated, tough luck, you get the msgid.
LANGUAGE_FALLBACKS = ['en']


@zope.interface.implementer(ITranslationDomain)
class TranslationDomain:

    def __init__(self, domain, fallbacks=None):
        self.domain = (
            domain.decode("utf-8") if isinstance(domain, bytes) else domain)
        # _catalogs maps (language, domain) to IMessageCatalog instances
        self._catalogs = {}
        # _data maps IMessageCatalog.getIdentifier() to IMessageCatalog
        self._data = {}
        # What languages to fallback to, if there is no catalog for the
        # requested language (no fallback on individual messages)
        self.setLanguageFallbacks(fallbacks)

    def _registerMessageCatalog(self, language, catalog_name):
        key = language
        if "@" in key:
            # sr@Latn and sr@Cyrl are two character set variants of
            # the same Serbian language.
            # See https://github.com/collective/plone.app.locales/issues/326
            key = key.split("@")[0]
        mc = self._catalogs.setdefault(key, [])
        mc.append(catalog_name)

    def addCatalog(self, catalog):
        self._data[catalog.getIdentifier()] = catalog
        self._registerMessageCatalog(catalog.language,
                                     catalog.getIdentifier())

    def setLanguageFallbacks(self, fallbacks=None):
        if fallbacks is None:
            fallbacks = LANGUAGE_FALLBACKS
        self._fallbacks = fallbacks

    def translate(self, msgid, mapping=None, context=None,
                  target_language=None, default=None,
                  msgid_plural=None, default_plural=None, number=None):
        """See zope.i18n.interfaces.ITranslationDomain"""
        # if the msgid is empty, let's save a lot of calculations and return
        # an empty string.
        if msgid == '':
            return ''

        if target_language is None and context is not None:
            langs = self._catalogs.keys()
            # invoke local or global unnamed 'INegotiator' utilities
            negotiator = zope.component.getUtility(INegotiator)
            # try to determine target language from negotiator utility
            target_language = negotiator.getLanguage(langs, context)

        return self._recursive_translate(
            msgid, mapping, target_language, default, context,
            msgid_plural, default_plural, number)

    def _recursive_translate(self, msgid, mapping, target_language, default,
                             context, msgid_plural, default_plural, number,
                             seen=None):
        """Recursively translate msg."""
        # MessageID attributes override arguments
        if isinstance(msgid, Message):
            if msgid.domain != self.domain:
                return translate(
                    msgid, msgid.domain, mapping, context, target_language,
                    default, msgid_plural, default_plural, number)
            default = msgid.default
            mapping = msgid.mapping
            msgid_plural = msgid.msgid_plural
            default_plural = msgid.default_plural
            number = msgid.number

        # Recursively translate mappings, if they are translatable
        if (mapping is not None
                and Message in (type(m) for m in mapping.values())):
            if seen is None:
                seen = set()
            seen.add((msgid, msgid_plural))
            mapping = mapping.copy()
            for key, value in mapping.items():
                if isinstance(value, Message):
                    # TODO Why isn't there an IMessage interface?
                    # https://bugs.launchpad.net/zope3/+bug/220122
                    if (value, value.msgid_plural) in seen:
                        raise ValueError(
                            "Circular reference in mappings detected: %s" %
                            value)
                    mapping[key] = self._recursive_translate(
                        value, mapping, target_language, default, context,
                        msgid_plural, default_plural, number, seen)

        if default is None:
            default = str(msgid)
        if msgid_plural is not None and default_plural is None:
            default_plural = str(msgid_plural)

        # Get the translation. Use the specified fallbacks if this fails
        catalog_names = self._catalogs.get(target_language)
        if catalog_names is None:
            for language in self._fallbacks:
                catalog_names = self._catalogs.get(language)
                if catalog_names is not None:
                    break

        text = default
        if catalog_names:
            if len(catalog_names) == 1:
                # this is a slight optimization for the case when there is a
                # single catalog. More importantly, it is extremely helpful
                # when testing and the test language is used, because it
                # allows the test language to get the default.
                if msgid_plural is not None:
                    # This is a plural
                    text = self._data[catalog_names[0]].queryPluralMessage(
                        msgid, msgid_plural, number, default, default_plural)
                else:
                    text = self._data[catalog_names[0]].queryMessage(
                        msgid, default)
            else:
                for name in catalog_names:
                    catalog = self._data[name]
                    if msgid_plural is not None:
                        # This is a plural
                        s = catalog.queryPluralMessage(
                            msgid, msgid_plural, number,
                            default, default_plural)
                    else:
                        s = catalog.queryMessage(msgid)
                    if s is not None:
                        text = s
                        break

        # Now we need to do the interpolation
        if text and mapping:
            text = interpolate(text, mapping)
        return text

    def getCatalogsInfo(self):
        return self._catalogs

    def reloadCatalogs(self, catalogNames):
        for catalogName in catalogNames:
            self._data[catalogName].reload()

1	##############################################################################
2	#
3	# Copyright (c) 2001-2008 Zope Foundation and Contributors.
4	# All Rights Reserved.
5	#
6	# This software is subject to the provisions of the Zope Public License,
7	# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
8	# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
9	# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
10	# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
11	# FOR A PARTICULAR PURPOSE.
12	#
13	##############################################################################
14	"""Global Translation Service for providing I18n to file-based code.
15	"""
16
17	import zope.component	1✔
18	import zope.interface	1✔
19	from zope.i18nmessageid import Message	1✔
20
21	from zope.i18n import interpolate	1✔
22	from zope.i18n import translate	1✔
23	from zope.i18n.interfaces import INegotiator	1✔
24	from zope.i18n.interfaces import ITranslationDomain	1✔
25
26
27	# The configuration should specify a list of fallback languages for the
28	# site. If a particular catalog for a negotiated language is not available,
29	# then the zcml specified order should be tried. If that fails, then as a
30	# last resort the languages in the following list are tried. If these fail
31	# too, then the msgid is returned.
32	#
33	# Note that these fallbacks are used only to find a catalog. If a particular
34	# message in a catalog is not translated, tough luck, you get the msgid.
35	LANGUAGE_FALLBACKS = ['en']	1✔
36
37
38	@zope.interface.implementer(ITranslationDomain)	1✔
39	class TranslationDomain:	1✔
40
41	def __init__(self, domain, fallbacks=None):	1✔
42	self.domain = (	1✔
43	domain.decode("utf-8") if isinstance(domain, bytes) else domain)
44	# _catalogs maps (language, domain) to IMessageCatalog instances
45	self._catalogs = {}	1✔
46	# _data maps IMessageCatalog.getIdentifier() to IMessageCatalog
47	self._data = {}	1✔
48	# What languages to fallback to, if there is no catalog for the
49	# requested language (no fallback on individual messages)
50	self.setLanguageFallbacks(fallbacks)	1✔
51
52	def _registerMessageCatalog(self, language, catalog_name):	1✔
53	key = language	1✔
54	if "@" in key:	1✔
55	# sr@Latn and sr@Cyrl are two character set variants of
56	# the same Serbian language.
57	# See https://github.com/collective/plone.app.locales/issues/326
58	key = key.split("@")[0]	1✔
59	mc = self._catalogs.setdefault(key, [])	1✔
60	mc.append(catalog_name)	1✔
61
62	def addCatalog(self, catalog):	1✔
63	self._data[catalog.getIdentifier()] = catalog	1✔
64	self._registerMessageCatalog(catalog.language,	1✔
65	catalog.getIdentifier())
66
67	def setLanguageFallbacks(self, fallbacks=None):	1✔
68	if fallbacks is None:	1✔
69	fallbacks = LANGUAGE_FALLBACKS	1✔
70	self._fallbacks = fallbacks	1✔
71
72	def translate(self, msgid, mapping=None, context=None,	1✔
73	target_language=None, default=None,
74	msgid_plural=None, default_plural=None, number=None):
75	"""See zope.i18n.interfaces.ITranslationDomain"""
76	# if the msgid is empty, let's save a lot of calculations and return
77	# an empty string.
78	if msgid == '':	1✔
79	return ''	1✔
80
81	if target_language is None and context is not None:	1✔
82	langs = self._catalogs.keys()	1✔
83	# invoke local or global unnamed 'INegotiator' utilities
84	negotiator = zope.component.getUtility(INegotiator)	1✔
85	# try to determine target language from negotiator utility
86	target_language = negotiator.getLanguage(langs, context)	1✔
87
88	return self._recursive_translate(	1✔
89	msgid, mapping, target_language, default, context,
90	msgid_plural, default_plural, number)
91
92	def _recursive_translate(self, msgid, mapping, target_language, default,	1✔
93	context, msgid_plural, default_plural, number,
94	seen=None):
95	"""Recursively translate msg."""
96	# MessageID attributes override arguments
97	if isinstance(msgid, Message):	1✔
98	if msgid.domain != self.domain:	1✔
99	return translate(	1✔
100	msgid, msgid.domain, mapping, context, target_language,
101	default, msgid_plural, default_plural, number)
102	default = msgid.default	1✔
103	mapping = msgid.mapping	1✔
104	msgid_plural = msgid.msgid_plural	1✔
105	default_plural = msgid.default_plural	1✔
106	number = msgid.number	1✔
107
108	# Recursively translate mappings, if they are translatable
109	if (mapping is not None	1✔
110	and Message in (type(m) for m in mapping.values())):
111	if seen is None:	1!
112	seen = set()	1✔
113	seen.add((msgid, msgid_plural))	1✔
114	mapping = mapping.copy()	1✔
115	for key, value in mapping.items():	1✔
116	if isinstance(value, Message):	1!
117	# TODO Why isn't there an IMessage interface?
118	# https://bugs.launchpad.net/zope3/+bug/220122
119	if (value, value.msgid_plural) in seen:	1!
UNCOV 120	raise ValueError(	×
121	"Circular reference in mappings detected: %s" %
122	value)
123	mapping[key] = self._recursive_translate(	1✔
124	value, mapping, target_language, default, context,
125	msgid_plural, default_plural, number, seen)
126
127	if default is None:	1✔
128	default = str(msgid)	1✔
129	if msgid_plural is not None and default_plural is None:	1✔
130	default_plural = str(msgid_plural)	1✔
131
132	# Get the translation. Use the specified fallbacks if this fails
133	catalog_names = self._catalogs.get(target_language)	1✔
134	if catalog_names is None:	1✔
135	for language in self._fallbacks:	1✔
136	catalog_names = self._catalogs.get(language)	1✔
137	if catalog_names is not None:	1✔
138	break	1✔
139
140	text = default	1✔
141	if catalog_names:	1✔
142	if len(catalog_names) == 1:	1✔
143	# this is a slight optimization for the case when there is a
144	# single catalog. More importantly, it is extremely helpful
145	# when testing and the test language is used, because it
146	# allows the test language to get the default.
147	if msgid_plural is not None:	1✔
148	# This is a plural
149	text = self._data[catalog_names[0]].queryPluralMessage(	1✔
150	msgid, msgid_plural, number, default, default_plural)
151	else:
152	text = self._data[catalog_names[0]].queryMessage(	1✔
153	msgid, default)
154	else:
155	for name in catalog_names:	1!
156	catalog = self._data[name]	1✔
157	if msgid_plural is not None:	1✔
158	# This is a plural
159	s = catalog.queryPluralMessage(	1✔
160	msgid, msgid_plural, number,
161	default, default_plural)
162	else:
163	s = catalog.queryMessage(msgid)	1✔
164	if s is not None:	1✔
165	text = s	1✔
166	break	1✔
167
168	# Now we need to do the interpolation
169	if text and mapping:	1✔
170	text = interpolate(text, mapping)	1✔
171	return text	1✔
172
173	def getCatalogsInfo(self):	1✔
174	return self._catalogs	1✔
175
176	def reloadCatalogs(self, catalogNames):	1✔
177	for catalogName in catalogNames:	1✔
178	self._data[catalogName].reload()	1✔

zopefoundation / zope.i18n / 11047648627

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous