1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""Test fixtures for working with oslo_i18n.
"""
import fixtures
import six
from oslo_i18n import _lazy
from oslo_i18n import _message
class Translation(fixtures.Fixture):
"""Fixture for managing translatable strings.
This class provides methods for creating translatable strings
using both lazy translation and immediate translation. It can be
used to generate the different types of messages returned from
oslo_i18n to test code that may need to know about the type to
handle them differently (for example, error handling in WSGI apps,
or logging).
Use this class to generate messages instead of toggling the global
lazy flag and using the regular translation factory.
"""
def __init__(self, domain='test-domain'):
"""Initialize the fixture.
:param domain: The translation domain. This is not expected to
coincide with an actual set of message
catalogs, but it can.
:type domain: str
"""
self.domain = domain
def lazy(self, msg):
"""Return a lazily translated message.
:param msg: Input message string. May optionally include
positional or named string interpolation markers.
:type msg: str or unicode
"""
return _message.Message(msg, domain=self.domain)
def immediate(self, msg):
"""Return a string as though it had been translated immediately.
:param msg: Input message string. May optionally include
positional or named string interpolation markers.
:type msg: str or unicode
"""
return six.text_type(msg)
class ToggleLazy(fixtures.Fixture):
"""Fixture to toggle lazy translation on or off for a test."""
def __init__(self, enabled):
"""Force lazy translation on or off.
:param enabled: Flag controlling whether to enable or disable
lazy translation, passed to :func:`~oslo_i18n.enable_lazy`.
:type enabled: bool
"""
super(ToggleLazy, self).__init__()
self._enabled = enabled
self._original_value = _lazy.USE_LAZY
def setUp(self):
super(ToggleLazy, self).setUp()
self.addCleanup(self._restore_original)
_lazy.enable_lazy(self._enabled)
def _restore_original(self):
_lazy.enable_lazy(self._original_value)
|
