Development of an internal social media platform with personalised dashboards for students
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

__init__.py 7.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268
  1. """
  2. Internationalization support.
  3. """
  4. import re
  5. from contextlib import ContextDecorator
  6. from django.utils.functional import lazy
  7. __all__ = [
  8. 'activate', 'deactivate', 'override', 'deactivate_all',
  9. 'get_language', 'get_language_from_request',
  10. 'get_language_info', 'get_language_bidi',
  11. 'check_for_language', 'to_language', 'to_locale', 'templatize',
  12. 'gettext', 'gettext_lazy', 'gettext_noop',
  13. 'ugettext', 'ugettext_lazy', 'ugettext_noop',
  14. 'ngettext', 'ngettext_lazy',
  15. 'ungettext', 'ungettext_lazy',
  16. 'pgettext', 'pgettext_lazy',
  17. 'npgettext', 'npgettext_lazy',
  18. 'LANGUAGE_SESSION_KEY',
  19. ]
  20. LANGUAGE_SESSION_KEY = '_language'
  21. class TranslatorCommentWarning(SyntaxWarning):
  22. pass
  23. # Here be dragons, so a short explanation of the logic won't hurt:
  24. # We are trying to solve two problems: (1) access settings, in particular
  25. # settings.USE_I18N, as late as possible, so that modules can be imported
  26. # without having to first configure Django, and (2) if some other code creates
  27. # a reference to one of these functions, don't break that reference when we
  28. # replace the functions with their real counterparts (once we do access the
  29. # settings).
  30. class Trans:
  31. """
  32. The purpose of this class is to store the actual translation function upon
  33. receiving the first call to that function. After this is done, changes to
  34. USE_I18N will have no effect to which function is served upon request. If
  35. your tests rely on changing USE_I18N, you can delete all the functions
  36. from _trans.__dict__.
  37. Note that storing the function with setattr will have a noticeable
  38. performance effect, as access to the function goes the normal path,
  39. instead of using __getattr__.
  40. """
  41. def __getattr__(self, real_name):
  42. from django.conf import settings
  43. if settings.USE_I18N:
  44. from django.utils.translation import trans_real as trans
  45. else:
  46. from django.utils.translation import trans_null as trans
  47. setattr(self, real_name, getattr(trans, real_name))
  48. return getattr(trans, real_name)
  49. _trans = Trans()
  50. # The Trans class is no more needed, so remove it from the namespace.
  51. del Trans
  52. def gettext_noop(message):
  53. return _trans.gettext_noop(message)
  54. ugettext_noop = gettext_noop
  55. def gettext(message):
  56. return _trans.gettext(message)
  57. # An alias since Django 2.0
  58. ugettext = gettext
  59. def ngettext(singular, plural, number):
  60. return _trans.ngettext(singular, plural, number)
  61. # An alias since Django 2.0
  62. ungettext = ngettext
  63. def pgettext(context, message):
  64. return _trans.pgettext(context, message)
  65. def npgettext(context, singular, plural, number):
  66. return _trans.npgettext(context, singular, plural, number)
  67. gettext_lazy = ugettext_lazy = lazy(gettext, str)
  68. pgettext_lazy = lazy(pgettext, str)
  69. def lazy_number(func, resultclass, number=None, **kwargs):
  70. if isinstance(number, int):
  71. kwargs['number'] = number
  72. proxy = lazy(func, resultclass)(**kwargs)
  73. else:
  74. original_kwargs = kwargs.copy()
  75. class NumberAwareString(resultclass):
  76. def __bool__(self):
  77. return bool(kwargs['singular'])
  78. def __mod__(self, rhs):
  79. if isinstance(rhs, dict) and number:
  80. try:
  81. number_value = rhs[number]
  82. except KeyError:
  83. raise KeyError(
  84. "Your dictionary lacks key '%s\'. Please provide "
  85. "it, because it is required to determine whether "
  86. "string is singular or plural." % number
  87. )
  88. else:
  89. number_value = rhs
  90. kwargs['number'] = number_value
  91. translated = func(**kwargs)
  92. try:
  93. translated = translated % rhs
  94. except TypeError:
  95. # String doesn't contain a placeholder for the number.
  96. pass
  97. return translated
  98. proxy = lazy(lambda **kwargs: NumberAwareString(), NumberAwareString)(**kwargs)
  99. proxy.__reduce__ = lambda: (_lazy_number_unpickle, (func, resultclass, number, original_kwargs))
  100. return proxy
  101. def _lazy_number_unpickle(func, resultclass, number, kwargs):
  102. return lazy_number(func, resultclass, number=number, **kwargs)
  103. def ngettext_lazy(singular, plural, number=None):
  104. return lazy_number(ngettext, str, singular=singular, plural=plural, number=number)
  105. # An alias since Django 2.0
  106. ungettext_lazy = ngettext_lazy
  107. def npgettext_lazy(context, singular, plural, number=None):
  108. return lazy_number(npgettext, str, context=context, singular=singular, plural=plural, number=number)
  109. def activate(language):
  110. return _trans.activate(language)
  111. def deactivate():
  112. return _trans.deactivate()
  113. class override(ContextDecorator):
  114. def __init__(self, language, deactivate=False):
  115. self.language = language
  116. self.deactivate = deactivate
  117. def __enter__(self):
  118. self.old_language = get_language()
  119. if self.language is not None:
  120. activate(self.language)
  121. else:
  122. deactivate_all()
  123. def __exit__(self, exc_type, exc_value, traceback):
  124. if self.old_language is None:
  125. deactivate_all()
  126. elif self.deactivate:
  127. deactivate()
  128. else:
  129. activate(self.old_language)
  130. def get_language():
  131. return _trans.get_language()
  132. def get_language_bidi():
  133. return _trans.get_language_bidi()
  134. def check_for_language(lang_code):
  135. return _trans.check_for_language(lang_code)
  136. def to_language(locale):
  137. """Turn a locale name (en_US) into a language name (en-us)."""
  138. p = locale.find('_')
  139. if p >= 0:
  140. return locale[:p].lower() + '-' + locale[p + 1:].lower()
  141. else:
  142. return locale.lower()
  143. def to_locale(language):
  144. """Turn a language name (en-us) into a locale name (en_US)."""
  145. language = language.lower()
  146. parts = language.split('-')
  147. try:
  148. country = parts[1]
  149. except IndexError:
  150. return language
  151. # A language with > 2 characters after the dash only has its first
  152. # character after the dash capitalized; e.g. sr-latn becomes sr_Latn.
  153. # A language with 2 characters after the dash has both characters
  154. # capitalized; e.g. en-us becomes en_US.
  155. parts[1] = country.title() if len(country) > 2 else country.upper()
  156. return parts[0] + '_' + '-'.join(parts[1:])
  157. def get_language_from_request(request, check_path=False):
  158. return _trans.get_language_from_request(request, check_path)
  159. def get_language_from_path(path):
  160. return _trans.get_language_from_path(path)
  161. def get_supported_language_variant(lang_code, *, strict=False):
  162. return _trans.get_supported_language_variant(lang_code, strict)
  163. def templatize(src, **kwargs):
  164. from .template import templatize
  165. return templatize(src, **kwargs)
  166. def deactivate_all():
  167. return _trans.deactivate_all()
  168. def get_language_info(lang_code):
  169. from django.conf.locale import LANG_INFO
  170. try:
  171. lang_info = LANG_INFO[lang_code]
  172. if 'fallback' in lang_info and 'name' not in lang_info:
  173. info = get_language_info(lang_info['fallback'][0])
  174. else:
  175. info = lang_info
  176. except KeyError:
  177. if '-' not in lang_code:
  178. raise KeyError("Unknown language code %s." % lang_code)
  179. generic_lang_code = lang_code.split('-')[0]
  180. try:
  181. info = LANG_INFO[generic_lang_code]
  182. except KeyError:
  183. raise KeyError("Unknown language code %s and %s." % (lang_code, generic_lang_code))
  184. if info:
  185. info['name_translated'] = gettext_lazy(info['name'])
  186. return info
  187. trim_whitespace_re = re.compile(r'\s*\n\s*')
  188. def trim_whitespace(s):
  189. return trim_whitespace_re.sub(' ', s.strip())