T=T for Auth, Grid, and Form

Author: mdipierro

apps/_scaffold/common.py

@@ -87,7 +87,7 @@
 # #######################################################
 # Instantiate the object and actions that handle auth
 # #######################################################
-auth = Auth(session, db, define_tables=False)
+auth = Auth(session, db, define_tables=False, T=T)
 auth.use_username = True
 auth.param.registration_requires_confirmation = settings.VERIFY_EMAIL
 auth.param.registration_requires_approval = settings.REQUIRES_APPROVAL

py4web/utils/auth.py

@@ -245,6 +245,7 @@ def __init__(
         two_factor_validate=None,
         template_args=None,
         logger=None,
+        T=None,
     ):
         # configuration parameters
         self.param = Param(
@@ -278,6 +279,12 @@ def __init__(
         # callbacks for forms
         self.on_accept = {}
 
+        # translator: if provided, translate user-facing messages immediately
+        self.T = T if T is not None else (lambda s: s)
+        self._messages_translated = False
+        if T is not None:
+            self._translate_messages(T)
+
         self.__prerequisites__ = []
         self.inject = inject
         if session:
@@ -981,6 +988,23 @@ def _error(self, message, code=400):
     def _success(self, message, code=200):
         return {"status": "success", "message": message, "code": code}
 
+    def _translate_messages(self, T):
+        """Wrap every string value in self.param.messages with T()."""
+        for group in self.param.messages.values():
+            for key, value in group.items():
+                if isinstance(value, str):
+                    group[key] = T(value)
+                elif (
+                    key == "body"
+                    and isinstance(value, (list, tuple))
+                    and len(value) == 2
+                ):
+                    group[key] = (T(value[0]), T(value[1]))
+                else:
+                    raise RuntimeError(f"Invalid message type {key}:{value}")
+        self.T = T
+        self._messages_translated = True
+
     # Other service methods (that can be overwritten)
 
     def send(self, name, user, **attrs):
@@ -1064,20 +1088,8 @@ def enable(self, route="auth", uses=(), env=None, spa=False, allow_api_routes=Tr
         auth = self
 
         translators = [fixture for fixture in uses if isinstance(fixture, Translator)]
-        if translators:
-            T = translators[0]
-            for group in self.param.messages.values():
-                for key, value in group.items():
-                    if isinstance(value, str):
-                        group[key] = T(value)
-                    elif (
-                        key == "body"
-                        and isinstance(value, (list, tuple))
-                        and len(value) == 2
-                    ):
-                        group[key] = (T(value[0]), T(value[1]))
-                    else:
-                        raise RuntimeError(f"Invalid message type {key}:{value}")
+        if translators and not self._messages_translated:
+            self._translate_messages(translators[0])
 
         methods = ["GET", "POST", "OPTIONS"]
 
@@ -1602,7 +1614,7 @@ def register(self, model=False):
                 self.auth.get_or_delete_existing_unverified_account(email)
         extra_form_fields = self.auth.extra_form_fields.get("register", [])
         fields += extra_form_fields
-        form = Form(fields, submit_value=button_name, formstyle=self.formstyle)
+        form = Form(fields, submit_value=button_name, formstyle=self.formstyle, T=self.auth.T)
         user = None
         if form.accepted:
             # notice that here the form is already validated
@@ -1740,6 +1752,7 @@ def login(self, model=False):
             fields,
             submit_value=button_name,
             formstyle=self.formstyle,
+            T=self.auth.T,
         )
         user = None
         next_url = prevent_open_redirect(request.query.get("next"))
@@ -1863,6 +1876,7 @@ def two_factor_validate(form):
             form_name="auth_2fa",
             keep_values=True,
             hidden=dict(next_url=next_url),
+            T=self.auth.T,
         )
 
         if form.accepted:
@@ -1936,6 +1950,7 @@ def request_reset_password(self, model=False):
             fields,
             submit_value=button_name,
             formstyle=self.formstyle,
+            T=self.auth.T,
         )
         if form.accepted:
             email = form.vars.get("email", "")
@@ -2004,6 +2019,7 @@ def reset_password(self, model=False):
             fields,
             formstyle=self.formstyle,
             submit_value=button_name,
+            T=self.auth.T,
         )
         self._process_change_password_form(form, user, False)
         if form.accepted:
@@ -2049,6 +2065,7 @@ def change_password(self, model=False):
             fields,
             formstyle=self.formstyle,
             submit_value=button_name,
+            T=self.auth.T,
         )
         user = self.auth.db.auth_user(self.auth.user_id)
         self._process_change_password_form(form, user, True)

py4web/utils/form.py

@@ -223,7 +223,8 @@ def make(self, field, value, error, title, placeholder="", readonly=False):
 
 
 class FileUploadWidget:
-    def make(self, field, value, error, title, placeholder="", readonly=False):
+    def make(self, field, value, error, title, placeholder="", readonly=False, T=None):
+        T = T or (lambda s: s)
         field_id = to_id(field)
         control = DIV()
         if value and not error:
@@ -232,11 +233,11 @@ def make(self, field, value, error, title, placeholder="", readonly=False):
             if not readonly:
                 download_div.append(
                     LABEL(
-                        "Currently:  ",
+                        T("Currently:  "),
                     )
                 )
             url = getattr(field, "download_url", lambda value: "#")(value)
-            download_div.append(A(" download ", _href=url))
+            download_div.append(A(T(" download "), _href=url))
 
             if not readonly:
                 download_div.append(
@@ -247,13 +248,13 @@ def make(self, field, value, error, title, placeholder="", readonly=False):
                         _title=title,
                     )
                 )
-                download_div.append(" (check to remove)")
+                download_div.append(T(" (check to remove)"))
 
             control.append(download_div)
 
-            control.append(LABEL("Change: "))
+            control.append(LABEL(T("Change: ")))
         else:
-            control.append(LABEL("Upload: "))
+            control.append(LABEL(T("Upload: ")))
         control.append(INPUT(_type="file", _id=field_id, _name=field.name))
         return control
 
@@ -300,8 +301,10 @@ def __call__(
         showreadonly,
         show_id,
         kwargs=None,
+        T=None,
     ):
         kwargs = kwargs if kwargs else {}
+        T = T or (lambda s: s)
 
         kwargs["_accept-charset"] = "utf8"
         form_method = "POST"
@@ -388,8 +391,8 @@ def __call__(
             field_value = None
 
             field_name = field.name
-            field_comment = field.comment if field.comment else ""
-            field_label = field.label
+            field_comment = T(field.comment) if isinstance(field.comment, str) and field.comment else (field.comment or "")
+            field_label = T(field.label) if isinstance(field.label, str) else field.label
             input_id = to_id(field)
             if is_virtual:
                 value = None
@@ -451,7 +454,7 @@ def __call__(
                     )
                     # do we need the variables below?
                     delete_field_attributes = dict()
-                    delete_field_attributes["_label"] = "Remove"
+                    delete_field_attributes["_label"] = T("Remove")
                     delete_field_attributes["_value"] = "ON"
                     delete_field_attributes["_type"] = "checkbox"
                     delete_field_attributes["_name"] = "_delete_" + field.name
@@ -466,7 +469,10 @@ def __call__(
                 else:
                     widget = Widget()
 
-                control = widget.make(field, value, error, title, placeholder)
+                if isinstance(widget, FileUploadWidget):
+                    control = widget.make(field, value, error, title, placeholder, T=T)
+                else:
+                    control = widget.make(field, value, error, title, placeholder)
 
             key = control.name.rstrip("/")
 
@@ -515,13 +521,13 @@ def __call__(
                         wrapped,
                         LABEL(
                             " ",
-                            field.label,
+                            field_label,
                             _for=input_id,
                             _class=class_label,
                             _style="display: inline !important",
                         ),
                         P(error, _class=class_error) if error else "",
-                        P(field.comment or "", _class=class_info),
+                        P(field_comment, _class=class_info),
                         _class=class_outer,
                     )
                 )
@@ -533,10 +539,10 @@ def __call__(
 
                 form.append(
                     DIV(
-                        LABEL(field.label, _for=input_id, _class=class_label),
+                        LABEL(field_label, _for=input_id, _class=class_label),
                         wrapped,
                         P(error, _class=class_error) if error else "",
-                        P(field.comment or "", _class=class_info),
+                        P(field_comment, _class=class_info),
                         _class=class_outer,
                     )
                 )
@@ -551,7 +557,7 @@ def __call__(
             deletable_field_type = "checkbox"
 
             # Set the deletable json field attributes.
-            deletable_record_attributes["_label"] = " check to delete"
+            deletable_record_attributes["_label"] = T(" check to delete")
             deletable_record_attributes["_name"] = deletable_field_name
             deletable_record_attributes["_type"] = deletable_field_type
             deletable_record_attributes["_class"] = self.classes["input[type=checkbox]"]
@@ -590,7 +596,7 @@ def __call__(
         submit_button_field_type = "submit"
 
         # Set the deletable json field attributes.
-        submit_button_attributes["_label"] = "Submit"
+        submit_button_attributes["_label"] = T("Submit")
         submit_button_attributes["_type"] = submit_button_field_type
         submit_button_attributes["_class"] = self.classes["input[type=submit]"]
 
@@ -599,7 +605,7 @@ def __call__(
 
         controls["submit"] = INPUT(
             _type=submit_button_field_type,
-            _value="Submit",
+            _value=T("Submit"),
             _class=self.classes["input[type=submit]"],
         )
 
@@ -769,11 +775,17 @@ def __init__(
         csrf_protection=True,
         lifespan=None,
         signing_info=None,
-        submit_value="Submit",
+        submit_value=None,
         show_id=False,
         auto_process=True,
+        T=None,
         **kwargs,
     ):
+        self.T = T if T is not None else (lambda s: s)
+        if submit_value is None:
+            submit_value = self.T("Submit")
+        elif isinstance(submit_value, str):
+            submit_value = self.T(submit_value)
         self.param = Param(
             formstyle=formstyle,
             hidden=hidden,
@@ -1027,6 +1039,7 @@ def helper(self):
                 self.showreadonly,
                 show_id=self.show_id,
                 kwargs=self.kwargs,
+                T=self.T,
             )
             for item in self.param.sidecar:
                 helper["form"][-1][-1].append(item)

py4web/utils/grid.py

@@ -656,7 +656,7 @@ def _handle_mode_new(self):
         if not self.is_creatable():
             raise HTTP(
                 403,
-                f"You do not have access to create a record in the {self.tablename} table.",
+                str(self.T("You do not have access to create a record in the %s table.")) % self.tablename,
             )
         self.form = self._make_form(readonly=False)
         if self.param.new_sidecar:
@@ -669,7 +669,7 @@ def _handle_mode_details(self):
         if not self.is_readable(self.record):
             raise HTTP(
                 403,
-                f"You do not have access to read a record from the {self.tablename} table.",
+                str(self.T("You do not have access to read a record from the %s table.")) % self.tablename,
             )
         self.form = self._make_form(readonly=True)
         if self.param.details_sidecar:
@@ -682,7 +682,7 @@ def _handle_mode_edit(self):
         if not self.is_editable(self.record):
             raise HTTP(
                 403,
-                f"You do not have access to edit a record in the {self.tablename} table.",
+                str(self.T("You do not have access to edit a record in the %s table.")) % self.tablename,
             )
         self.form = self._make_form(readonly=False)
         if self.param.edit_sidecar:
@@ -910,6 +910,7 @@ def _make_form(self, readonly):
             formstyle=self.param.formstyle,
             validation=self.param.validation,
             show_id=self.param.show_id,
+            T=self.T,
         )
 
     def _iter_pages(