Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 1 | """Internationalization and localization support. |
| 2 | |
| 3 | This module provides internationalization (I18N) and localization (L10N) |
| 4 | support for your Python programs by providing an interface to the GNU gettext |
| 5 | message catalog library. |
| 6 | |
| 7 | I18N refers to the operation by which a program is made aware of multiple |
| 8 | languages. L10N refers to the adaptation of your program, once |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 9 | internationalized, to the local language and cultural habits. |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 10 | |
| 11 | """ |
| 12 | |
Barry Warsaw | fa488ec | 2000-08-25 20:26:43 +0000 | [diff] [blame] | 13 | # This module represents the integration of work, contributions, feedback, and |
| 14 | # suggestions from the following people: |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 15 | # |
| 16 | # Martin von Loewis, who wrote the initial implementation of the underlying |
| 17 | # C-based libintlmodule (later renamed _gettext), along with a skeletal |
| 18 | # gettext.py implementation. |
| 19 | # |
| 20 | # Peter Funk, who wrote fintl.py, a fairly complete wrapper around intlmodule, |
| 21 | # which also included a pure-Python implementation to read .mo files if |
| 22 | # intlmodule wasn't available. |
| 23 | # |
| 24 | # James Henstridge, who also wrote a gettext.py module, which has some |
| 25 | # interesting, but currently unsupported experimental features: the notion of |
| 26 | # a Catalog class and instances, and the ability to add to a catalog file via |
| 27 | # a Python API. |
| 28 | # |
| 29 | # Barry Warsaw integrated these modules, wrote the .install() API and code, |
| 30 | # and conformed all C and Python code to Python's coding standards. |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 31 | # |
| 32 | # Francois Pinard and Marc-Andre Lemburg also contributed valuably to this |
| 33 | # module. |
| 34 | # |
Martin v. Löwis | a57dccd | 2003-03-10 16:01:43 +0000 | [diff] [blame] | 35 | # J. David Ibanez implemented plural forms. Bruno Haible fixed some bugs. |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 36 | # |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 37 | # TODO: |
| 38 | # - Lazy loading of .mo files. Currently the entire catalog is loaded into |
| 39 | # memory, but that's probably bad for large translated programs. Instead, |
| 40 | # the lexical sort of original strings in GNU .mo files should be exploited |
| 41 | # to do binary searches and lazy initializations. Or you might want to use |
| 42 | # the undocumented double-hash algorithm for .mo files with hash tables, but |
| 43 | # you'll need to study the GNU gettext code to do this. |
| 44 | # |
| 45 | # - Support Solaris .mo file formats. Unfortunately, we've been unable to |
| 46 | # find this format documented anywhere. |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 47 | |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 48 | |
Victor Stinner | d6debb2 | 2017-03-27 16:05:26 +0200 | [diff] [blame] | 49 | import os |
| 50 | import re |
Victor Stinner | d6debb2 | 2017-03-27 16:05:26 +0200 | [diff] [blame] | 51 | import sys |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 52 | |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 53 | |
Barry Warsaw | a1ce93f | 2003-04-11 18:36:43 +0000 | [diff] [blame] | 54 | __all__ = ['NullTranslations', 'GNUTranslations', 'Catalog', |
| 55 | 'find', 'translation', 'install', 'textdomain', 'bindtextdomain', |
Andrew Kuchling | 770b08e | 2015-04-13 09:58:36 -0400 | [diff] [blame] | 56 | 'bind_textdomain_codeset', |
| 57 | 'dgettext', 'dngettext', 'gettext', 'lgettext', 'ldgettext', |
| 58 | 'ldngettext', 'lngettext', 'ngettext', |
Cheryl Sabella | 637a33b | 2018-11-07 09:12:20 -0500 | [diff] [blame] | 59 | 'pgettext', 'dpgettext', 'npgettext', 'dnpgettext', |
Barry Warsaw | a1ce93f | 2003-04-11 18:36:43 +0000 | [diff] [blame] | 60 | ] |
Skip Montanaro | 2dd4276 | 2001-01-23 15:35:05 +0000 | [diff] [blame] | 61 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 62 | _default_localedir = os.path.join(sys.base_prefix, 'share', 'locale') |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 63 | |
Serhiy Storchaka | 07bcf05 | 2016-11-08 21:17:46 +0200 | [diff] [blame] | 64 | # Expression parsing for plural form selection. |
| 65 | # |
| 66 | # The gettext library supports a small subset of C syntax. The only |
| 67 | # incompatible difference is that integer literals starting with zero are |
| 68 | # decimal. |
| 69 | # |
| 70 | # https://www.gnu.org/software/gettext/manual/gettext.html#Plural-forms |
| 71 | # http://git.savannah.gnu.org/cgit/gettext.git/tree/gettext-runtime/intl/plural.y |
| 72 | |
| 73 | _token_pattern = re.compile(r""" |
| 74 | (?P<WHITESPACES>[ \t]+) | # spaces and horizontal tabs |
| 75 | (?P<NUMBER>[0-9]+\b) | # decimal integer |
| 76 | (?P<NAME>n\b) | # only n is allowed |
| 77 | (?P<PARENTHESIS>[()]) | |
| 78 | (?P<OPERATOR>[-*/%+?:]|[><!]=?|==|&&|\|\|) | # !, *, /, %, +, -, <, >, |
| 79 | # <=, >=, ==, !=, &&, ||, |
| 80 | # ? : |
| 81 | # unary and bitwise ops |
| 82 | # not allowed |
| 83 | (?P<INVALID>\w+|.) # invalid token |
| 84 | """, re.VERBOSE|re.DOTALL) |
| 85 | |
| 86 | def _tokenize(plural): |
| 87 | for mo in re.finditer(_token_pattern, plural): |
| 88 | kind = mo.lastgroup |
| 89 | if kind == 'WHITESPACES': |
| 90 | continue |
| 91 | value = mo.group(kind) |
| 92 | if kind == 'INVALID': |
| 93 | raise ValueError('invalid token in plural form: %s' % value) |
| 94 | yield value |
| 95 | yield '' |
| 96 | |
| 97 | def _error(value): |
| 98 | if value: |
| 99 | return ValueError('unexpected token in plural form: %s' % value) |
| 100 | else: |
| 101 | return ValueError('unexpected end of plural form') |
| 102 | |
| 103 | _binary_ops = ( |
| 104 | ('||',), |
| 105 | ('&&',), |
| 106 | ('==', '!='), |
| 107 | ('<', '>', '<=', '>='), |
| 108 | ('+', '-'), |
| 109 | ('*', '/', '%'), |
| 110 | ) |
| 111 | _binary_ops = {op: i for i, ops in enumerate(_binary_ops, 1) for op in ops} |
| 112 | _c2py_ops = {'||': 'or', '&&': 'and', '/': '//'} |
| 113 | |
| 114 | def _parse(tokens, priority=-1): |
| 115 | result = '' |
| 116 | nexttok = next(tokens) |
| 117 | while nexttok == '!': |
| 118 | result += 'not ' |
| 119 | nexttok = next(tokens) |
| 120 | |
| 121 | if nexttok == '(': |
| 122 | sub, nexttok = _parse(tokens) |
| 123 | result = '%s(%s)' % (result, sub) |
| 124 | if nexttok != ')': |
| 125 | raise ValueError('unbalanced parenthesis in plural form') |
| 126 | elif nexttok == 'n': |
| 127 | result = '%s%s' % (result, nexttok) |
| 128 | else: |
| 129 | try: |
| 130 | value = int(nexttok, 10) |
| 131 | except ValueError: |
| 132 | raise _error(nexttok) from None |
| 133 | result = '%s%d' % (result, value) |
| 134 | nexttok = next(tokens) |
| 135 | |
| 136 | j = 100 |
| 137 | while nexttok in _binary_ops: |
| 138 | i = _binary_ops[nexttok] |
| 139 | if i < priority: |
| 140 | break |
| 141 | # Break chained comparisons |
| 142 | if i in (3, 4) and j in (3, 4): # '==', '!=', '<', '>', '<=', '>=' |
| 143 | result = '(%s)' % result |
| 144 | # Replace some C operators by their Python equivalents |
| 145 | op = _c2py_ops.get(nexttok, nexttok) |
| 146 | right, nexttok = _parse(tokens, i + 1) |
| 147 | result = '%s %s %s' % (result, op, right) |
| 148 | j = i |
| 149 | if j == priority == 4: # '<', '>', '<=', '>=' |
| 150 | result = '(%s)' % result |
| 151 | |
| 152 | if nexttok == '?' and priority <= 0: |
| 153 | if_true, nexttok = _parse(tokens, 0) |
| 154 | if nexttok != ':': |
| 155 | raise _error(nexttok) |
| 156 | if_false, nexttok = _parse(tokens) |
| 157 | result = '%s if %s else %s' % (if_true, result, if_false) |
| 158 | if priority == 0: |
| 159 | result = '(%s)' % result |
| 160 | |
| 161 | return result, nexttok |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 162 | |
Serhiy Storchaka | 60ac989 | 2016-11-14 19:22:12 +0200 | [diff] [blame] | 163 | def _as_int(n): |
| 164 | try: |
| 165 | i = round(n) |
| 166 | except TypeError: |
| 167 | raise TypeError('Plural value must be an integer, got %s' % |
| 168 | (n.__class__.__name__,)) from None |
Serhiy Storchaka | f659598 | 2017-03-12 13:15:01 +0200 | [diff] [blame] | 169 | import warnings |
| 170 | warnings.warn('Plural value must be an integer, got %s' % |
| 171 | (n.__class__.__name__,), |
| 172 | DeprecationWarning, 4) |
Serhiy Storchaka | 60ac989 | 2016-11-14 19:22:12 +0200 | [diff] [blame] | 173 | return n |
| 174 | |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 175 | def c2py(plural): |
Barry Warsaw | c4acc2b | 2003-04-24 18:13:39 +0000 | [diff] [blame] | 176 | """Gets a C expression as used in PO files for plural forms and returns a |
Serhiy Storchaka | 07bcf05 | 2016-11-08 21:17:46 +0200 | [diff] [blame] | 177 | Python function that implements an equivalent expression. |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 178 | """ |
Serhiy Storchaka | 07bcf05 | 2016-11-08 21:17:46 +0200 | [diff] [blame] | 179 | |
| 180 | if len(plural) > 1000: |
| 181 | raise ValueError('plural form expression is too long') |
Martin v. Löwis | a57dccd | 2003-03-10 16:01:43 +0000 | [diff] [blame] | 182 | try: |
Serhiy Storchaka | 07bcf05 | 2016-11-08 21:17:46 +0200 | [diff] [blame] | 183 | result, nexttok = _parse(_tokenize(plural)) |
| 184 | if nexttok: |
| 185 | raise _error(nexttok) |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 186 | |
Serhiy Storchaka | 07bcf05 | 2016-11-08 21:17:46 +0200 | [diff] [blame] | 187 | depth = 0 |
| 188 | for c in result: |
| 189 | if c == '(': |
| 190 | depth += 1 |
| 191 | if depth > 20: |
| 192 | # Python compiler limit is about 90. |
| 193 | # The most complex example has 2. |
| 194 | raise ValueError('plural form expression is too complex') |
| 195 | elif c == ')': |
| 196 | depth -= 1 |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 197 | |
Serhiy Storchaka | 60ac989 | 2016-11-14 19:22:12 +0200 | [diff] [blame] | 198 | ns = {'_as_int': _as_int} |
Serhiy Storchaka | 07bcf05 | 2016-11-08 21:17:46 +0200 | [diff] [blame] | 199 | exec('''if True: |
| 200 | def func(n): |
| 201 | if not isinstance(n, int): |
Serhiy Storchaka | 60ac989 | 2016-11-14 19:22:12 +0200 | [diff] [blame] | 202 | n = _as_int(n) |
Serhiy Storchaka | 07bcf05 | 2016-11-08 21:17:46 +0200 | [diff] [blame] | 203 | return int(%s) |
| 204 | ''' % result, ns) |
| 205 | return ns['func'] |
Serhiy Storchaka | eb20fca | 2016-11-08 21:26:14 +0200 | [diff] [blame] | 206 | except RecursionError: |
Serhiy Storchaka | 07bcf05 | 2016-11-08 21:17:46 +0200 | [diff] [blame] | 207 | # Recursion error can be raised in _parse() or exec(). |
| 208 | raise ValueError('plural form expression is too complex') |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 209 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 210 | |
Benjamin Peterson | 31e8720 | 2010-12-23 22:53:42 +0000 | [diff] [blame] | 211 | def _expand_lang(loc): |
Hai Shi | 7443d42 | 2020-05-14 09:22:30 +0800 | [diff] [blame] | 212 | import locale |
Benjamin Peterson | 31e8720 | 2010-12-23 22:53:42 +0000 | [diff] [blame] | 213 | loc = locale.normalize(loc) |
Barry Warsaw | fa488ec | 2000-08-25 20:26:43 +0000 | [diff] [blame] | 214 | COMPONENT_CODESET = 1 << 0 |
| 215 | COMPONENT_TERRITORY = 1 << 1 |
| 216 | COMPONENT_MODIFIER = 1 << 2 |
| 217 | # split up the locale into its base components |
| 218 | mask = 0 |
Benjamin Peterson | 31e8720 | 2010-12-23 22:53:42 +0000 | [diff] [blame] | 219 | pos = loc.find('@') |
Barry Warsaw | fa488ec | 2000-08-25 20:26:43 +0000 | [diff] [blame] | 220 | if pos >= 0: |
Benjamin Peterson | 31e8720 | 2010-12-23 22:53:42 +0000 | [diff] [blame] | 221 | modifier = loc[pos:] |
| 222 | loc = loc[:pos] |
Barry Warsaw | fa488ec | 2000-08-25 20:26:43 +0000 | [diff] [blame] | 223 | mask |= COMPONENT_MODIFIER |
| 224 | else: |
| 225 | modifier = '' |
Benjamin Peterson | 31e8720 | 2010-12-23 22:53:42 +0000 | [diff] [blame] | 226 | pos = loc.find('.') |
Barry Warsaw | fa488ec | 2000-08-25 20:26:43 +0000 | [diff] [blame] | 227 | if pos >= 0: |
Benjamin Peterson | 31e8720 | 2010-12-23 22:53:42 +0000 | [diff] [blame] | 228 | codeset = loc[pos:] |
| 229 | loc = loc[:pos] |
Barry Warsaw | fa488ec | 2000-08-25 20:26:43 +0000 | [diff] [blame] | 230 | mask |= COMPONENT_CODESET |
| 231 | else: |
| 232 | codeset = '' |
Benjamin Peterson | 31e8720 | 2010-12-23 22:53:42 +0000 | [diff] [blame] | 233 | pos = loc.find('_') |
Barry Warsaw | fa488ec | 2000-08-25 20:26:43 +0000 | [diff] [blame] | 234 | if pos >= 0: |
Benjamin Peterson | 31e8720 | 2010-12-23 22:53:42 +0000 | [diff] [blame] | 235 | territory = loc[pos:] |
| 236 | loc = loc[:pos] |
Barry Warsaw | fa488ec | 2000-08-25 20:26:43 +0000 | [diff] [blame] | 237 | mask |= COMPONENT_TERRITORY |
| 238 | else: |
| 239 | territory = '' |
Benjamin Peterson | 31e8720 | 2010-12-23 22:53:42 +0000 | [diff] [blame] | 240 | language = loc |
Barry Warsaw | fa488ec | 2000-08-25 20:26:43 +0000 | [diff] [blame] | 241 | ret = [] |
| 242 | for i in range(mask+1): |
| 243 | if not (i & ~mask): # if all components for this combo exist ... |
| 244 | val = language |
| 245 | if i & COMPONENT_TERRITORY: val += territory |
| 246 | if i & COMPONENT_CODESET: val += codeset |
| 247 | if i & COMPONENT_MODIFIER: val += modifier |
| 248 | ret.append(val) |
| 249 | ret.reverse() |
| 250 | return ret |
| 251 | |
| 252 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 253 | |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 254 | class NullTranslations: |
| 255 | def __init__(self, fp=None): |
| 256 | self._info = {} |
Barry Warsaw | 6008cbd | 2003-04-11 20:26:47 +0000 | [diff] [blame] | 257 | self._charset = None |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 258 | self._output_charset = None |
Martin v. Löwis | a55ffae | 2002-01-11 06:58:49 +0000 | [diff] [blame] | 259 | self._fallback = None |
Raymond Hettinger | 094662a | 2002-06-01 01:29:16 +0000 | [diff] [blame] | 260 | if fp is not None: |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 261 | self._parse(fp) |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 262 | |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 263 | def _parse(self, fp): |
| 264 | pass |
| 265 | |
Martin v. Löwis | a55ffae | 2002-01-11 06:58:49 +0000 | [diff] [blame] | 266 | def add_fallback(self, fallback): |
| 267 | if self._fallback: |
| 268 | self._fallback.add_fallback(fallback) |
| 269 | else: |
| 270 | self._fallback = fallback |
| 271 | |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 272 | def gettext(self, message): |
Martin v. Löwis | a55ffae | 2002-01-11 06:58:49 +0000 | [diff] [blame] | 273 | if self._fallback: |
| 274 | return self._fallback.gettext(message) |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 275 | return message |
| 276 | |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 277 | def lgettext(self, message): |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 278 | import warnings |
| 279 | warnings.warn('lgettext() is deprecated, use gettext() instead', |
| 280 | DeprecationWarning, 2) |
Hai Shi | 7443d42 | 2020-05-14 09:22:30 +0800 | [diff] [blame] | 281 | import locale |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 282 | if self._fallback: |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 283 | with warnings.catch_warnings(): |
| 284 | warnings.filterwarnings('ignore', r'.*\blgettext\b.*', |
| 285 | DeprecationWarning) |
| 286 | return self._fallback.lgettext(message) |
Serhiy Storchaka | 26cb465 | 2017-06-20 17:13:29 +0300 | [diff] [blame] | 287 | if self._output_charset: |
| 288 | return message.encode(self._output_charset) |
| 289 | return message.encode(locale.getpreferredencoding()) |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 290 | |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 291 | def ngettext(self, msgid1, msgid2, n): |
| 292 | if self._fallback: |
| 293 | return self._fallback.ngettext(msgid1, msgid2, n) |
| 294 | if n == 1: |
| 295 | return msgid1 |
| 296 | else: |
| 297 | return msgid2 |
| 298 | |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 299 | def lngettext(self, msgid1, msgid2, n): |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 300 | import warnings |
| 301 | warnings.warn('lngettext() is deprecated, use ngettext() instead', |
| 302 | DeprecationWarning, 2) |
Hai Shi | 7443d42 | 2020-05-14 09:22:30 +0800 | [diff] [blame] | 303 | import locale |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 304 | if self._fallback: |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 305 | with warnings.catch_warnings(): |
| 306 | warnings.filterwarnings('ignore', r'.*\blngettext\b.*', |
| 307 | DeprecationWarning) |
| 308 | return self._fallback.lngettext(msgid1, msgid2, n) |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 309 | if n == 1: |
Serhiy Storchaka | 26cb465 | 2017-06-20 17:13:29 +0300 | [diff] [blame] | 310 | tmsg = msgid1 |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 311 | else: |
Serhiy Storchaka | 26cb465 | 2017-06-20 17:13:29 +0300 | [diff] [blame] | 312 | tmsg = msgid2 |
| 313 | if self._output_charset: |
| 314 | return tmsg.encode(self._output_charset) |
| 315 | return tmsg.encode(locale.getpreferredencoding()) |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 316 | |
Cheryl Sabella | 637a33b | 2018-11-07 09:12:20 -0500 | [diff] [blame] | 317 | def pgettext(self, context, message): |
| 318 | if self._fallback: |
| 319 | return self._fallback.pgettext(context, message) |
| 320 | return message |
| 321 | |
| 322 | def npgettext(self, context, msgid1, msgid2, n): |
| 323 | if self._fallback: |
| 324 | return self._fallback.npgettext(context, msgid1, msgid2, n) |
| 325 | if n == 1: |
| 326 | return msgid1 |
| 327 | else: |
| 328 | return msgid2 |
| 329 | |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 330 | def info(self): |
| 331 | return self._info |
| 332 | |
| 333 | def charset(self): |
| 334 | return self._charset |
| 335 | |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 336 | def output_charset(self): |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 337 | import warnings |
| 338 | warnings.warn('output_charset() is deprecated', |
| 339 | DeprecationWarning, 2) |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 340 | return self._output_charset |
| 341 | |
| 342 | def set_output_charset(self, charset): |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 343 | import warnings |
| 344 | warnings.warn('set_output_charset() is deprecated', |
| 345 | DeprecationWarning, 2) |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 346 | self._output_charset = charset |
| 347 | |
Benjamin Peterson | 801844d | 2008-07-14 14:32:15 +0000 | [diff] [blame] | 348 | def install(self, names=None): |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 349 | import builtins |
Benjamin Peterson | 801844d | 2008-07-14 14:32:15 +0000 | [diff] [blame] | 350 | builtins.__dict__['_'] = self.gettext |
Cheryl Sabella | 637a33b | 2018-11-07 09:12:20 -0500 | [diff] [blame] | 351 | if names is not None: |
| 352 | allowed = {'gettext', 'lgettext', 'lngettext', |
| 353 | 'ngettext', 'npgettext', 'pgettext'} |
| 354 | for name in allowed & set(names): |
| 355 | builtins.__dict__[name] = getattr(self, name) |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 356 | |
| 357 | |
| 358 | class GNUTranslations(NullTranslations): |
| 359 | # Magic number of .mo files |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 360 | LE_MAGIC = 0x950412de |
| 361 | BE_MAGIC = 0xde120495 |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 362 | |
Cheryl Sabella | 637a33b | 2018-11-07 09:12:20 -0500 | [diff] [blame] | 363 | # The encoding of a msgctxt and a msgid in a .mo file is |
| 364 | # msgctxt + "\x04" + msgid (gettext version >= 0.15) |
| 365 | CONTEXT = "%s\x04%s" |
| 366 | |
Antoine Pitrou | be8d06f | 2014-10-28 20:17:51 +0100 | [diff] [blame] | 367 | # Acceptable .mo versions |
| 368 | VERSIONS = (0, 1) |
| 369 | |
| 370 | def _get_versions(self, version): |
| 371 | """Returns a tuple of major version, minor version""" |
| 372 | return (version >> 16, version & 0xffff) |
| 373 | |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 374 | def _parse(self, fp): |
| 375 | """Override this method to support alternative .mo formats.""" |
Serhiy Storchaka | 8110837 | 2017-09-26 00:55:55 +0300 | [diff] [blame] | 376 | # Delay struct import for speeding up gettext import when .mo files |
| 377 | # are not used. |
| 378 | from struct import unpack |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 379 | filename = getattr(fp, 'name', '') |
| 380 | # Parse the .mo file header, which consists of 5 little endian 32 |
| 381 | # bit words. |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 382 | self._catalog = catalog = {} |
Martin v. Löwis | a57dccd | 2003-03-10 16:01:43 +0000 | [diff] [blame] | 383 | self.plural = lambda n: int(n != 1) # germanic plural by default |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 384 | buf = fp.read() |
Barry Warsaw | 9a2d9d7 | 2000-08-31 23:28:52 +0000 | [diff] [blame] | 385 | buflen = len(buf) |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 386 | # Are we big endian or little endian? |
Barry Warsaw | 09707e3 | 2002-08-14 15:09:12 +0000 | [diff] [blame] | 387 | magic = unpack('<I', buf[:4])[0] |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 388 | if magic == self.LE_MAGIC: |
Barry Warsaw | 09707e3 | 2002-08-14 15:09:12 +0000 | [diff] [blame] | 389 | version, msgcount, masteridx, transidx = unpack('<4I', buf[4:20]) |
| 390 | ii = '<II' |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 391 | elif magic == self.BE_MAGIC: |
Barry Warsaw | 09707e3 | 2002-08-14 15:09:12 +0000 | [diff] [blame] | 392 | version, msgcount, masteridx, transidx = unpack('>4I', buf[4:20]) |
| 393 | ii = '>II' |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 394 | else: |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 395 | raise OSError(0, 'Bad magic number', filename) |
Antoine Pitrou | be8d06f | 2014-10-28 20:17:51 +0100 | [diff] [blame] | 396 | |
| 397 | major_version, minor_version = self._get_versions(version) |
| 398 | |
| 399 | if major_version not in self.VERSIONS: |
| 400 | raise OSError(0, 'Bad version number ' + str(major_version), filename) |
| 401 | |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 402 | # Now put all messages from the .mo file buffer into the catalog |
| 403 | # dictionary. |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 404 | for i in range(0, msgcount): |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 405 | mlen, moff = unpack(ii, buf[masteridx:masteridx+8]) |
Barry Warsaw | 09707e3 | 2002-08-14 15:09:12 +0000 | [diff] [blame] | 406 | mend = moff + mlen |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 407 | tlen, toff = unpack(ii, buf[transidx:transidx+8]) |
Barry Warsaw | 09707e3 | 2002-08-14 15:09:12 +0000 | [diff] [blame] | 408 | tend = toff + tlen |
Barry Warsaw | 9a2d9d7 | 2000-08-31 23:28:52 +0000 | [diff] [blame] | 409 | if mend < buflen and tend < buflen: |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 410 | msg = buf[moff:mend] |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 411 | tmsg = buf[toff:tend] |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 412 | else: |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 413 | raise OSError(0, 'File is corrupt', filename) |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 414 | # See if we're looking at GNU .mo conventions for metadata |
Barry Warsaw | 6008cbd | 2003-04-11 20:26:47 +0000 | [diff] [blame] | 415 | if mlen == 0: |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 416 | # Catalog description |
Andrew Kuchling | 8b963c5 | 2015-04-13 10:38:56 -0400 | [diff] [blame] | 417 | lastk = None |
Serhiy Storchaka | 26cb465 | 2017-06-20 17:13:29 +0300 | [diff] [blame] | 418 | for b_item in tmsg.split(b'\n'): |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 419 | item = b_item.decode().strip() |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 420 | if not item: |
| 421 | continue |
Julien Palard | afd1e6d | 2019-05-09 16:22:15 +0200 | [diff] [blame] | 422 | # Skip over comment lines: |
| 423 | if item.startswith('#-#-#-#-#') and item.endswith('#-#-#-#-#'): |
| 424 | continue |
Andrew Kuchling | 8b963c5 | 2015-04-13 10:38:56 -0400 | [diff] [blame] | 425 | k = v = None |
Barry Warsaw | 7de63f5 | 2003-05-20 17:26:48 +0000 | [diff] [blame] | 426 | if ':' in item: |
| 427 | k, v = item.split(':', 1) |
| 428 | k = k.strip().lower() |
| 429 | v = v.strip() |
| 430 | self._info[k] = v |
| 431 | lastk = k |
| 432 | elif lastk: |
| 433 | self._info[lastk] += '\n' + item |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 434 | if k == 'content-type': |
| 435 | self._charset = v.split('charset=')[1] |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 436 | elif k == 'plural-forms': |
| 437 | v = v.split(';') |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 438 | plural = v[1].split('plural=')[1] |
| 439 | self.plural = c2py(plural) |
Barry Warsaw | c4acc2b | 2003-04-24 18:13:39 +0000 | [diff] [blame] | 440 | # Note: we unconditionally convert both msgids and msgstrs to |
| 441 | # Unicode using the character encoding specified in the charset |
| 442 | # parameter of the Content-Type header. The gettext documentation |
Ezio Melotti | 42da663 | 2011-03-15 05:18:48 +0200 | [diff] [blame] | 443 | # strongly encourages msgids to be us-ascii, but some applications |
Barry Warsaw | c4acc2b | 2003-04-24 18:13:39 +0000 | [diff] [blame] | 444 | # require alternative encodings (e.g. Zope's ZCML and ZPT). For |
| 445 | # traditional gettext applications, the msgid conversion will |
| 446 | # cause no problems since us-ascii should always be a subset of |
| 447 | # the charset encoding. We may want to fall back to 8-bit msgids |
| 448 | # if the Unicode conversion fails. |
Georg Brandl | bded4d3 | 2008-07-17 18:15:35 +0000 | [diff] [blame] | 449 | charset = self._charset or 'ascii' |
Guido van Rossum | 652f446 | 2007-07-12 08:04:06 +0000 | [diff] [blame] | 450 | if b'\x00' in msg: |
Barry Warsaw | 6008cbd | 2003-04-11 20:26:47 +0000 | [diff] [blame] | 451 | # Plural forms |
Guido van Rossum | 9600f93 | 2007-08-29 03:08:55 +0000 | [diff] [blame] | 452 | msgid1, msgid2 = msg.split(b'\x00') |
| 453 | tmsg = tmsg.split(b'\x00') |
Georg Brandl | bded4d3 | 2008-07-17 18:15:35 +0000 | [diff] [blame] | 454 | msgid1 = str(msgid1, charset) |
| 455 | for i, x in enumerate(tmsg): |
| 456 | catalog[(msgid1, i)] = str(x, charset) |
Barry Warsaw | 6008cbd | 2003-04-11 20:26:47 +0000 | [diff] [blame] | 457 | else: |
Georg Brandl | bded4d3 | 2008-07-17 18:15:35 +0000 | [diff] [blame] | 458 | catalog[str(msg, charset)] = str(tmsg, charset) |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 459 | # advance to next entry in the seek tables |
Barry Warsaw | fa488ec | 2000-08-25 20:26:43 +0000 | [diff] [blame] | 460 | masteridx += 8 |
| 461 | transidx += 8 |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 462 | |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 463 | def lgettext(self, message): |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 464 | import warnings |
| 465 | warnings.warn('lgettext() is deprecated, use gettext() instead', |
| 466 | DeprecationWarning, 2) |
Hai Shi | 7443d42 | 2020-05-14 09:22:30 +0800 | [diff] [blame] | 467 | import locale |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 468 | missing = object() |
| 469 | tmsg = self._catalog.get(message, missing) |
| 470 | if tmsg is missing: |
| 471 | if self._fallback: |
| 472 | return self._fallback.lgettext(message) |
Serhiy Storchaka | 26cb465 | 2017-06-20 17:13:29 +0300 | [diff] [blame] | 473 | tmsg = message |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 474 | if self._output_charset: |
| 475 | return tmsg.encode(self._output_charset) |
| 476 | return tmsg.encode(locale.getpreferredencoding()) |
| 477 | |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 478 | def lngettext(self, msgid1, msgid2, n): |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 479 | import warnings |
| 480 | warnings.warn('lngettext() is deprecated, use ngettext() instead', |
| 481 | DeprecationWarning, 2) |
Hai Shi | 7443d42 | 2020-05-14 09:22:30 +0800 | [diff] [blame] | 482 | import locale |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 483 | try: |
| 484 | tmsg = self._catalog[(msgid1, self.plural(n))] |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 485 | except KeyError: |
| 486 | if self._fallback: |
| 487 | return self._fallback.lngettext(msgid1, msgid2, n) |
| 488 | if n == 1: |
Serhiy Storchaka | 26cb465 | 2017-06-20 17:13:29 +0300 | [diff] [blame] | 489 | tmsg = msgid1 |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 490 | else: |
Serhiy Storchaka | 26cb465 | 2017-06-20 17:13:29 +0300 | [diff] [blame] | 491 | tmsg = msgid2 |
| 492 | if self._output_charset: |
| 493 | return tmsg.encode(self._output_charset) |
| 494 | return tmsg.encode(locale.getpreferredencoding()) |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 495 | |
Benjamin Peterson | 801844d | 2008-07-14 14:32:15 +0000 | [diff] [blame] | 496 | def gettext(self, message): |
Barry Warsaw | a1ce93f | 2003-04-11 18:36:43 +0000 | [diff] [blame] | 497 | missing = object() |
| 498 | tmsg = self._catalog.get(message, missing) |
| 499 | if tmsg is missing: |
Martin v. Löwis | a55ffae | 2002-01-11 06:58:49 +0000 | [diff] [blame] | 500 | if self._fallback: |
Benjamin Peterson | 801844d | 2008-07-14 14:32:15 +0000 | [diff] [blame] | 501 | return self._fallback.gettext(message) |
Georg Brandl | bded4d3 | 2008-07-17 18:15:35 +0000 | [diff] [blame] | 502 | return message |
Barry Warsaw | a1ce93f | 2003-04-11 18:36:43 +0000 | [diff] [blame] | 503 | return tmsg |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 504 | |
Benjamin Peterson | 801844d | 2008-07-14 14:32:15 +0000 | [diff] [blame] | 505 | def ngettext(self, msgid1, msgid2, n): |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 506 | try: |
| 507 | tmsg = self._catalog[(msgid1, self.plural(n))] |
| 508 | except KeyError: |
| 509 | if self._fallback: |
Benjamin Peterson | 801844d | 2008-07-14 14:32:15 +0000 | [diff] [blame] | 510 | return self._fallback.ngettext(msgid1, msgid2, n) |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 511 | if n == 1: |
Georg Brandl | bded4d3 | 2008-07-17 18:15:35 +0000 | [diff] [blame] | 512 | tmsg = msgid1 |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 513 | else: |
Georg Brandl | bded4d3 | 2008-07-17 18:15:35 +0000 | [diff] [blame] | 514 | tmsg = msgid2 |
Barry Warsaw | a1ce93f | 2003-04-11 18:36:43 +0000 | [diff] [blame] | 515 | return tmsg |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 516 | |
Cheryl Sabella | 637a33b | 2018-11-07 09:12:20 -0500 | [diff] [blame] | 517 | def pgettext(self, context, message): |
| 518 | ctxt_msg_id = self.CONTEXT % (context, message) |
| 519 | missing = object() |
| 520 | tmsg = self._catalog.get(ctxt_msg_id, missing) |
| 521 | if tmsg is missing: |
| 522 | if self._fallback: |
| 523 | return self._fallback.pgettext(context, message) |
| 524 | return message |
| 525 | return tmsg |
| 526 | |
| 527 | def npgettext(self, context, msgid1, msgid2, n): |
| 528 | ctxt_msg_id = self.CONTEXT % (context, msgid1) |
| 529 | try: |
| 530 | tmsg = self._catalog[ctxt_msg_id, self.plural(n)] |
| 531 | except KeyError: |
| 532 | if self._fallback: |
| 533 | return self._fallback.npgettext(context, msgid1, msgid2, n) |
| 534 | if n == 1: |
| 535 | tmsg = msgid1 |
| 536 | else: |
| 537 | tmsg = msgid2 |
| 538 | return tmsg |
| 539 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 540 | |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 541 | # Locate a .mo file using the gettext strategy |
Georg Brandl | cd86925 | 2009-05-17 12:50:58 +0000 | [diff] [blame] | 542 | def find(domain, localedir=None, languages=None, all=False): |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 543 | # Get some reasonable defaults for arguments that were not supplied |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 544 | if localedir is None: |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 545 | localedir = _default_localedir |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 546 | if languages is None: |
| 547 | languages = [] |
| 548 | for envar in ('LANGUAGE', 'LC_ALL', 'LC_MESSAGES', 'LANG'): |
| 549 | val = os.environ.get(envar) |
| 550 | if val: |
| 551 | languages = val.split(':') |
| 552 | break |
| 553 | if 'C' not in languages: |
| 554 | languages.append('C') |
Barry Warsaw | fa488ec | 2000-08-25 20:26:43 +0000 | [diff] [blame] | 555 | # now normalize and expand the languages |
Barry Warsaw | 75f8101 | 2000-10-16 15:47:50 +0000 | [diff] [blame] | 556 | nelangs = [] |
Barry Warsaw | fa488ec | 2000-08-25 20:26:43 +0000 | [diff] [blame] | 557 | for lang in languages: |
| 558 | for nelang in _expand_lang(lang): |
Barry Warsaw | 75f8101 | 2000-10-16 15:47:50 +0000 | [diff] [blame] | 559 | if nelang not in nelangs: |
| 560 | nelangs.append(nelang) |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 561 | # select a language |
Martin v. Löwis | a55ffae | 2002-01-11 06:58:49 +0000 | [diff] [blame] | 562 | if all: |
| 563 | result = [] |
| 564 | else: |
| 565 | result = None |
Barry Warsaw | 75f8101 | 2000-10-16 15:47:50 +0000 | [diff] [blame] | 566 | for lang in nelangs: |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 567 | if lang == 'C': |
| 568 | break |
Barry Warsaw | 84314b7 | 2000-08-25 19:53:17 +0000 | [diff] [blame] | 569 | mofile = os.path.join(localedir, lang, 'LC_MESSAGES', '%s.mo' % domain) |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 570 | if os.path.exists(mofile): |
Martin v. Löwis | a55ffae | 2002-01-11 06:58:49 +0000 | [diff] [blame] | 571 | if all: |
| 572 | result.append(mofile) |
| 573 | else: |
| 574 | return mofile |
| 575 | return result |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 576 | |
| 577 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 578 | |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 579 | # a mapping between absolute .mo file path and Translation object |
| 580 | _translations = {} |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 581 | _unspecified = ['unspecified'] |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 582 | |
Martin v. Löwis | 1be6419 | 2002-01-11 06:33:28 +0000 | [diff] [blame] | 583 | def translation(domain, localedir=None, languages=None, |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 584 | class_=None, fallback=False, codeset=_unspecified): |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 585 | if class_ is None: |
| 586 | class_ = GNUTranslations |
Georg Brandl | cd86925 | 2009-05-17 12:50:58 +0000 | [diff] [blame] | 587 | mofiles = find(domain, localedir, languages, all=True) |
Barry Warsaw | c4acc2b | 2003-04-24 18:13:39 +0000 | [diff] [blame] | 588 | if not mofiles: |
Martin v. Löwis | 1be6419 | 2002-01-11 06:33:28 +0000 | [diff] [blame] | 589 | if fallback: |
| 590 | return NullTranslations() |
Serhiy Storchaka | 8110837 | 2017-09-26 00:55:55 +0300 | [diff] [blame] | 591 | from errno import ENOENT |
| 592 | raise FileNotFoundError(ENOENT, |
| 593 | 'No translation file found for domain', domain) |
Barry Warsaw | 293b03f | 2000-10-05 18:48:12 +0000 | [diff] [blame] | 594 | # Avoid opening, reading, and parsing the .mo file after it's been done |
| 595 | # once. |
Martin v. Löwis | a55ffae | 2002-01-11 06:58:49 +0000 | [diff] [blame] | 596 | result = None |
| 597 | for mofile in mofiles: |
Éric Araujo | 6108bf5 | 2010-10-04 23:52:37 +0000 | [diff] [blame] | 598 | key = (class_, os.path.abspath(mofile)) |
Martin v. Löwis | a55ffae | 2002-01-11 06:58:49 +0000 | [diff] [blame] | 599 | t = _translations.get(key) |
| 600 | if t is None: |
Benjamin Peterson | fa0d703 | 2009-06-01 22:42:33 +0000 | [diff] [blame] | 601 | with open(mofile, 'rb') as fp: |
| 602 | t = _translations.setdefault(key, class_(fp)) |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 603 | # Copy the translation object to allow setting fallbacks and |
| 604 | # output charset. All other instance data is shared with the |
| 605 | # cached object. |
Serhiy Storchaka | 8110837 | 2017-09-26 00:55:55 +0300 | [diff] [blame] | 606 | # Delay copy import for speeding up gettext import when .mo files |
| 607 | # are not used. |
| 608 | import copy |
Martin v. Löwis | a55ffae | 2002-01-11 06:58:49 +0000 | [diff] [blame] | 609 | t = copy.copy(t) |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 610 | if codeset is not _unspecified: |
| 611 | import warnings |
| 612 | warnings.warn('parameter codeset is deprecated', |
| 613 | DeprecationWarning, 2) |
| 614 | if codeset: |
| 615 | with warnings.catch_warnings(): |
| 616 | warnings.filterwarnings('ignore', r'.*\bset_output_charset\b.*', |
| 617 | DeprecationWarning) |
| 618 | t.set_output_charset(codeset) |
Martin v. Löwis | a55ffae | 2002-01-11 06:58:49 +0000 | [diff] [blame] | 619 | if result is None: |
| 620 | result = t |
| 621 | else: |
| 622 | result.add_fallback(t) |
| 623 | return result |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 624 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 625 | |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 626 | def install(domain, localedir=None, codeset=_unspecified, names=None): |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 627 | t = translation(domain, localedir, fallback=True, codeset=codeset) |
Benjamin Peterson | 801844d | 2008-07-14 14:32:15 +0000 | [diff] [blame] | 628 | t.install(names) |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 629 | |
| 630 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 631 | |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 632 | # a mapping b/w domains and locale directories |
| 633 | _localedirs = {} |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 634 | # a mapping b/w domains and codesets |
| 635 | _localecodesets = {} |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 636 | # current global domain, `messages' used for compatibility w/ GNU gettext |
| 637 | _current_domain = 'messages' |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 638 | |
| 639 | |
| 640 | def textdomain(domain=None): |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 641 | global _current_domain |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 642 | if domain is not None: |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 643 | _current_domain = domain |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 644 | return _current_domain |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 645 | |
| 646 | |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 647 | def bindtextdomain(domain, localedir=None): |
| 648 | global _localedirs |
| 649 | if localedir is not None: |
| 650 | _localedirs[domain] = localedir |
| 651 | return _localedirs.get(domain, _default_localedir) |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 652 | |
| 653 | |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 654 | def bind_textdomain_codeset(domain, codeset=None): |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 655 | import warnings |
| 656 | warnings.warn('bind_textdomain_codeset() is deprecated', |
| 657 | DeprecationWarning, 2) |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 658 | global _localecodesets |
| 659 | if codeset is not None: |
| 660 | _localecodesets[domain] = codeset |
| 661 | return _localecodesets.get(domain) |
| 662 | |
| 663 | |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 664 | def dgettext(domain, message): |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 665 | try: |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 666 | t = translation(domain, _localedirs.get(domain, None)) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 667 | except OSError: |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 668 | return message |
| 669 | return t.gettext(message) |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 670 | |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 671 | def ldgettext(domain, message): |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 672 | import warnings |
| 673 | warnings.warn('ldgettext() is deprecated, use dgettext() instead', |
| 674 | DeprecationWarning, 2) |
Hai Shi | 7443d42 | 2020-05-14 09:22:30 +0800 | [diff] [blame] | 675 | import locale |
Serhiy Storchaka | 26cb465 | 2017-06-20 17:13:29 +0300 | [diff] [blame] | 676 | codeset = _localecodesets.get(domain) |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 677 | try: |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 678 | with warnings.catch_warnings(): |
| 679 | warnings.filterwarnings('ignore', r'.*\bparameter codeset\b.*', |
| 680 | DeprecationWarning) |
| 681 | t = translation(domain, _localedirs.get(domain, None), codeset=codeset) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 682 | except OSError: |
Serhiy Storchaka | 26cb465 | 2017-06-20 17:13:29 +0300 | [diff] [blame] | 683 | return message.encode(codeset or locale.getpreferredencoding()) |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 684 | with warnings.catch_warnings(): |
| 685 | warnings.filterwarnings('ignore', r'.*\blgettext\b.*', |
| 686 | DeprecationWarning) |
| 687 | return t.lgettext(message) |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 688 | |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 689 | def dngettext(domain, msgid1, msgid2, n): |
| 690 | try: |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 691 | t = translation(domain, _localedirs.get(domain, None)) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 692 | except OSError: |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 693 | if n == 1: |
| 694 | return msgid1 |
| 695 | else: |
| 696 | return msgid2 |
| 697 | return t.ngettext(msgid1, msgid2, n) |
| 698 | |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 699 | def ldngettext(domain, msgid1, msgid2, n): |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 700 | import warnings |
| 701 | warnings.warn('ldngettext() is deprecated, use dngettext() instead', |
| 702 | DeprecationWarning, 2) |
Hai Shi | 7443d42 | 2020-05-14 09:22:30 +0800 | [diff] [blame] | 703 | import locale |
Serhiy Storchaka | 26cb465 | 2017-06-20 17:13:29 +0300 | [diff] [blame] | 704 | codeset = _localecodesets.get(domain) |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 705 | try: |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 706 | with warnings.catch_warnings(): |
| 707 | warnings.filterwarnings('ignore', r'.*\bparameter codeset\b.*', |
| 708 | DeprecationWarning) |
| 709 | t = translation(domain, _localedirs.get(domain, None), codeset=codeset) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 710 | except OSError: |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 711 | if n == 1: |
Serhiy Storchaka | 26cb465 | 2017-06-20 17:13:29 +0300 | [diff] [blame] | 712 | tmsg = msgid1 |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 713 | else: |
Serhiy Storchaka | 26cb465 | 2017-06-20 17:13:29 +0300 | [diff] [blame] | 714 | tmsg = msgid2 |
| 715 | return tmsg.encode(codeset or locale.getpreferredencoding()) |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 716 | with warnings.catch_warnings(): |
| 717 | warnings.filterwarnings('ignore', r'.*\blngettext\b.*', |
| 718 | DeprecationWarning) |
| 719 | return t.lngettext(msgid1, msgid2, n) |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 720 | |
Cheryl Sabella | 637a33b | 2018-11-07 09:12:20 -0500 | [diff] [blame] | 721 | |
| 722 | def dpgettext(domain, context, message): |
| 723 | try: |
| 724 | t = translation(domain, _localedirs.get(domain, None)) |
| 725 | except OSError: |
| 726 | return message |
| 727 | return t.pgettext(context, message) |
| 728 | |
| 729 | |
| 730 | def dnpgettext(domain, context, msgid1, msgid2, n): |
| 731 | try: |
| 732 | t = translation(domain, _localedirs.get(domain, None)) |
| 733 | except OSError: |
| 734 | if n == 1: |
| 735 | return msgid1 |
| 736 | else: |
| 737 | return msgid2 |
| 738 | return t.npgettext(context, msgid1, msgid2, n) |
| 739 | |
| 740 | |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 741 | def gettext(message): |
| 742 | return dgettext(_current_domain, message) |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 743 | |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 744 | def lgettext(message): |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 745 | import warnings |
| 746 | warnings.warn('lgettext() is deprecated, use gettext() instead', |
| 747 | DeprecationWarning, 2) |
| 748 | with warnings.catch_warnings(): |
| 749 | warnings.filterwarnings('ignore', r'.*\bldgettext\b.*', |
| 750 | DeprecationWarning) |
| 751 | return ldgettext(_current_domain, message) |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 752 | |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 753 | def ngettext(msgid1, msgid2, n): |
| 754 | return dngettext(_current_domain, msgid1, msgid2, n) |
| 755 | |
Gustavo Niemeyer | 7bd33c5 | 2004-07-22 18:44:01 +0000 | [diff] [blame] | 756 | def lngettext(msgid1, msgid2, n): |
Serhiy Storchaka | fec35c9 | 2018-10-27 08:00:41 +0300 | [diff] [blame] | 757 | import warnings |
| 758 | warnings.warn('lngettext() is deprecated, use ngettext() instead', |
| 759 | DeprecationWarning, 2) |
| 760 | with warnings.catch_warnings(): |
| 761 | warnings.filterwarnings('ignore', r'.*\bldngettext\b.*', |
| 762 | DeprecationWarning) |
| 763 | return ldngettext(_current_domain, msgid1, msgid2, n) |
Martin v. Löwis | d899605 | 2002-11-21 21:45:32 +0000 | [diff] [blame] | 764 | |
Cheryl Sabella | 637a33b | 2018-11-07 09:12:20 -0500 | [diff] [blame] | 765 | |
| 766 | def pgettext(context, message): |
| 767 | return dpgettext(_current_domain, context, message) |
| 768 | |
| 769 | |
| 770 | def npgettext(context, msgid1, msgid2, n): |
| 771 | return dnpgettext(_current_domain, context, msgid1, msgid2, n) |
| 772 | |
| 773 | |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 774 | # dcgettext() has been deemed unnecessary and is not implemented. |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 775 | |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 776 | # James Henstridge's Catalog constructor from GNOME gettext. Documented usage |
| 777 | # was: |
| 778 | # |
| 779 | # import gettext |
| 780 | # cat = gettext.Catalog(PACKAGE, localedir=LOCALEDIR) |
| 781 | # _ = cat.gettext |
| 782 | # print _('Hello World') |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 783 | |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 784 | # The resulting catalog object currently don't support access through a |
| 785 | # dictionary API, which was supported (but apparently unused) in GNOME |
| 786 | # gettext. |
Barry Warsaw | 95be23d | 2000-08-25 19:13:37 +0000 | [diff] [blame] | 787 | |
Barry Warsaw | 33d8d70 | 2000-08-30 03:29:58 +0000 | [diff] [blame] | 788 | Catalog = translation |