Coverage for portality/internationalise.py: 81%
72 statements
« prev ^ index » next coverage.py v7.17.3, created at 2026-11-20 13:43 +0000
« prev ^ index » next coverage.py v7.17.3, created at 2026-11-20 13:43 +0000
1from urllib.parse import urlencode
3from flask import g, request, redirect, url_for, session
4from flask_babel import Babel
6DEFAULT_LOCALE = "en"
7DEFAULT_TIMEZONE = "UTC"
8LANGUAGES = ['en', 'fr']
9INCLUDE_ROUTES = {
10 'apply',
11 'account/login',
12 'apply/thank-you'
13 }
15def locale_middleware_with_query_params():
16 # Get locale from query parameter instead of URL path
17 lang = request.args.get('lang', DEFAULT_LOCALE)
18 if lang not in LANGUAGES:
19 lang = DEFAULT_LOCALE
20 g.lang = lang # Store in flask.g for easy access
21 return None # Continue with request
23def redirect_url(lang: str = DEFAULT_LOCALE):
24 query_params = request.args.to_dict()
25 query_params.pop('lang', None) # remove lang from query params which is not required
26 url_to_redirect = f"/{lang}{request.path}"
27 if query_params:
28 url_to_redirect = f"{url_to_redirect}?{urlencode(query_params)}"
29 return redirect(url_to_redirect)
31def locale_middleware():
32 try:
33 # Only handle GET requests, let POST pass through
34 if request.method != 'GET':
35 return None
37 # Redirect for included routes
38 if request.path and any(request.path.strip('/') == f'{route}' for route in INCLUDE_ROUTES):
39 # update selected language
40 lang = request.args.get('lang')
41 if lang:
42 if lang in LANGUAGES:
43 session['lang'] = lang
44 return redirect_url(lang)
46 if get_url_locale() is None:
47 return redirect_url(get_session_locale())
49 except RuntimeError:
50 pass
51 return None
53def get_url_locale():
54 # Get locale from URL
55 path_parts = request.path.split('/')
56 if len(path_parts) > 1:
57 url_locale = path_parts[1]
58 if url_locale in LANGUAGES:
59 session['lang'] = url_locale
60 return url_locale
61 return None
63def get_session_locale():
64 if 'lang' in session:
65 lang = session.get('lang')
66 if lang in LANGUAGES:
67 return lang
68 session['lang'] = DEFAULT_LOCALE
69 return DEFAULT_LOCALE
71def get_locale():
72 lang = get_url_locale()
73 if lang is None:
74 lang = DEFAULT_LOCALE
76 return lang
78def get_timezone():
79 user = getattr(g, 'user', None)
80 if user is not None:
81 return user.timezone
83 return DEFAULT_TIMEZONE
86def url_for_other_page(endpoint, **kwargs):
87 if 'lang' not in kwargs:
88 kwargs['lang'] = g.get('lang', DEFAULT_LOCALE)
89 return url_for(endpoint, **kwargs)
91def internationalise(app):
92 # Initialize internationalization using Flask-Babel
93 app.config['BABEL_DEFAULT_LOCALE'] = DEFAULT_LOCALE # Default
94 app.config['BABEL_DEFAULT_TIMEZONE'] = DEFAULT_TIMEZONE
95 app.config['LANGUAGES'] = LANGUAGES
96 app.config['BABEL_TRANSLATION_DIRECTORIES'] = "ui/translations"
98 app.babel = Babel(app, locale_selector=get_locale, timezone_selector=get_timezone)
100 # Add locale middleware
101 app.before_request(locale_middleware)
103 # Add to template context
104 app.jinja_env.globals['url_for_other_page'] = url_for_other_page