Unify preflight msg and hint into fix

Author: davegaeddert

plain-flags/plain/flags/admin.py

@@ -24,7 +24,7 @@ def get_number(self):
         return len(self.flag_errors)
 
     def get_text(self):
-        return "\n".join(str(e.msg) for e in self.flag_errors)
+        return "\n".join(str(e.message) for e in self.flag_errors)
 
 
 @register_viewset

plain-flags/plain/flags/models.py

@@ -95,10 +95,9 @@ def preflight(cls):
             except FlagImportError:
                 errors.append(
                     PreflightResult(
-                        f"Flag {flag_name} is not used.",
-                        hint=f"Remove the flag from the database or define it in the {settings.FLAGS_MODULE} module.",
+                        fix=f"Flag {flag_name} is not used. Remove the flag from the database or define it in the {settings.FLAGS_MODULE} module.",
                         warning=True,
-                        id="plain.flags.I001",
+                        id="flags.unused_flags",
                     )
                 )
 

plain-models/plain/models/backends/mysql/validation.py

@@ -14,13 +14,11 @@ def _check_sql_mode(self):
         ):
             return [
                 preflight.PreflightResult(
-                    f"{self.connection.display_name} Strict Mode is not set for the database connection",
-                    hint=(
-                        f"{self.connection.display_name}'s Strict Mode fixes many data integrity problems in "
-                        f"{self.connection.display_name}, such as data truncation upon insertion, by "
-                        "escalating warnings into errors. It is strongly "
-                        "recommended you activate it."
-                    ),
+                    fix=f"{self.connection.display_name} Strict Mode is not set for the database connection. "
+                    f"{self.connection.display_name}'s Strict Mode fixes many data integrity problems in "
+                    f"{self.connection.display_name}, such as data truncation upon insertion, by "
+                    "escalating warnings into errors. It is strongly "
+                    "recommended you activate it.",
                     id="mysql.strict_mode_not_enabled",
                     warning=True,
                 )
@@ -42,7 +40,7 @@ def check_field_type(self, field, field_type):
         ):
             errors.append(
                 preflight.PreflightResult(
-                    f"{self.connection.display_name} may not allow unique CharFields to have a max_length "
+                    fix=f"{self.connection.display_name} may not allow unique CharFields to have a max_length "
                     "> 255.",
                     obj=field,
                     id="mysql.unique_charfield_max_length_too_long",

plain-models/plain/models/base.py

@@ -232,23 +232,23 @@ def _check_field_name(self):
         if self.name.endswith("_"):
             return [
                 PreflightResult(
-                    "Field names must not end with an underscore.",
+                    fix="Field names must not end with an underscore.",
                     obj=self,
                     id="fields.name_ends_with_underscore",
                 )
             ]
         elif LOOKUP_SEP in self.name:
             return [
                 PreflightResult(
-                    f'Field names must not contain "{LOOKUP_SEP}".',
+                    fix=f'Field names must not contain "{LOOKUP_SEP}".',
                     obj=self,
                     id="fields.name_contains_lookup_separator",
                 )
             ]
         elif self.name == "id":
             return [
                 PreflightResult(
-                    "'id' is a reserved word that cannot be used as a field name.",
+                    fix="'id' is a reserved word that cannot be used as a field name.",
                     obj=self,
                     id="fields.reserved_field_name_id",
                 )
@@ -267,7 +267,7 @@ def _check_choices(self):
         if not is_iterable(self.choices) or isinstance(self.choices, str):
             return [
                 PreflightResult(
-                    "'choices' must be an iterable (e.g., a list or tuple).",
+                    fix="'choices' must be an iterable (e.g., a list or tuple).",
                     obj=self,
                     id="fields.choices_not_iterable",
                 )
@@ -315,7 +315,7 @@ def _check_choices(self):
             if self.max_length is not None and choice_max_length > self.max_length:
                 return [
                     PreflightResult(
-                        "'max_length' is too small to fit the longest value "  # noqa: UP031
+                        fix="'max_length' is too small to fit the longest value "  # noqa: UP031
                         "in 'choices' (%d characters)." % choice_max_length,
                         obj=self,
                         id="fields.max_length_too_small_for_choices",
@@ -325,7 +325,7 @@ def _check_choices(self):
 
         return [
             PreflightResult(
-                "'choices' must be an iterable containing "
+                fix="'choices' must be an iterable containing "
                 "(actual value, human readable name) tuples.",
                 obj=self,
                 id="fields.choices_invalid_format",
@@ -342,7 +342,7 @@ def _check_db_comment(self):
         ):
             errors.append(
                 PreflightResult(
-                    f"{db_connection.display_name} does not support comments on "
+                    fix=f"{db_connection.display_name} does not support comments on "
                     f"columns (db_comment).",
                     obj=self,
                     id="fields.db_comment_unsupported",
@@ -358,11 +358,9 @@ def _check_null_allowed_for_primary_keys(self):
             # character-based fields a little differently).
             return [
                 PreflightResult(
-                    "Primary keys must not have allow_null=True.",
-                    hint=(
-                        "Set allow_null=False on the field, or "
-                        "remove primary_key=True argument."
-                    ),
+                    fix="Primary keys must not have allow_null=True. "
+                    "Set allow_null=False on the field, or "
+                    "remove primary_key=True argument.",
                     obj=self,
                     id="fields.primary_key_allows_null",
                 )
@@ -381,8 +379,8 @@ def _check_validators(self):
             if not callable(validator):
                 errors.append(
                     PreflightResult(
-                        "All 'validators' must be callable.",
-                        hint=(
+                        fix=(
+                            "All 'validators' must be callable. "
                             f"validators[{i}] ({repr(validator)}) isn't a function or "
                             "instance of a validator class."
                         ),
@@ -969,7 +967,7 @@ def _check_max_length_attribute(self, **kwargs):
                 return []
             return [
                 PreflightResult(
-                    "CharFields must define a 'max_length' attribute.",
+                    fix="CharFields must define a 'max_length' attribute.",
                     obj=self,
                     id="fields.charfield_missing_max_length",
                 )
@@ -981,7 +979,7 @@ def _check_max_length_attribute(self, **kwargs):
         ):
             return [
                 PreflightResult(
-                    "'max_length' must be a positive integer.",
+                    fix="'max_length' must be a positive integer.",
                     obj=self,
                     id="fields.charfield_invalid_max_length",
                 )
@@ -999,7 +997,7 @@ def _check_db_collation(self):
         ):
             errors.append(
                 PreflightResult(
-                    f"{db_connection.display_name} does not support a database collation on "
+                    fix=f"{db_connection.display_name} does not support a database collation on "
                     "CharFields.",
                     obj=self,
                     id="fields.db_collation_unsupported",
@@ -1069,7 +1067,7 @@ def _check_mutually_exclusive_options(self):
         if enabled_options > 1:
             return [
                 PreflightResult(
-                    "The options auto_now, auto_now_add, and default "
+                    fix="The options auto_now, auto_now_add, and default "
                     "are mutually exclusive. Only one of these options "
                     "may be present.",
                     obj=self,
@@ -1105,13 +1103,11 @@ def _check_if_value_fixed(self, value, now=None):
         if lower <= value <= upper:
             return [
                 PreflightResult(
-                    "Fixed default value provided.",
-                    hint=(
-                        "It seems you set a fixed date / time / datetime "
-                        "value as default for this field. This may not be "
-                        "what you want. If you want to have the current date "
-                        "as default, use `plain.utils.timezone.now`"
-                    ),
+                    fix="Fixed default value provided. "
+                    "It seems you set a fixed date / time / datetime "
+                    "value as default for this field. This may not be "
+                    "what you want. If you want to have the current date "
+                    "as default, use `plain.utils.timezone.now`",
                     obj=self,
                     id="fields.datetime_naive_default_value",
                     warning=True,
@@ -1395,15 +1391,15 @@ def _check_decimal_places(self):
         except TypeError:
             return [
                 PreflightResult(
-                    "DecimalFields must define a 'decimal_places' attribute.",
+                    fix="DecimalFields must define a 'decimal_places' attribute.",
                     obj=self,
                     id="fields.decimalfield_missing_decimal_places",
                 )
             ]
         except ValueError:
             return [
                 PreflightResult(
-                    "'decimal_places' must be a non-negative integer.",
+                    fix="'decimal_places' must be a non-negative integer.",
                     obj=self,
                     id="fields.decimalfield_invalid_decimal_places",
                 )
@@ -1419,15 +1415,15 @@ def _check_max_digits(self):
         except TypeError:
             return [
                 PreflightResult(
-                    "DecimalFields must define a 'max_digits' attribute.",
+                    fix="DecimalFields must define a 'max_digits' attribute.",
                     obj=self,
                     id="fields.decimalfield_missing_max_digits",
                 )
             ]
         except ValueError:
             return [
                 PreflightResult(
-                    "'max_digits' must be a positive integer.",
+                    fix="'max_digits' must be a positive integer.",
                     obj=self,
                     id="fields.decimalfield_invalid_max_digits",
                 )
@@ -1439,7 +1435,7 @@ def _check_decimal_places_and_max_digits(self):
         if int(self.decimal_places) > int(self.max_digits):
             return [
                 PreflightResult(
-                    "'max_digits' must be greater or equal to 'decimal_places'.",
+                    fix="'max_digits' must be greater or equal to 'decimal_places'.",
                     obj=self,
                     id="fields.decimalfield_decimal_places_exceeds_max_digits",
                 )
@@ -1624,8 +1620,7 @@ def _check_max_length_warning(self):
         if self.max_length is not None:
             return [
                 PreflightResult(
-                    f"'max_length' is ignored when used with {self.__class__.__name__}.",
-                    hint="Remove 'max_length' from field",
+                    fix=f"'max_length' is ignored when used with {self.__class__.__name__}. Remove 'max_length' from field.",
                     obj=self,
                     id="fields.max_length_ignored",
                     warning=True,
@@ -1747,7 +1742,7 @@ def _check_required_and_null_values(self):
         ):
             return [
                 PreflightResult(
-                    "GenericIPAddressFields cannot have required=False if allow_null=False, "
+                    fix="GenericIPAddressFields cannot have required=False if allow_null=False, "
                     "as blank values are stored as nulls.",
                     obj=self,
                     id="fields.generic_ip_field_null_blank_config",
@@ -1869,7 +1864,7 @@ def _check_db_collation(self):
         ):
             errors.append(
                 PreflightResult(
-                    f"{db_connection.display_name} does not support a database collation on "
+                    fix=f"{db_connection.display_name} does not support a database collation on "
                     "TextFields.",
                     obj=self,
                     id="fields.db_collation_unsupported",
@@ -2032,7 +2027,7 @@ def _check_str_default_value(self):
         if self.has_default() and isinstance(self.default, str):
             return [
                 PreflightResult(
-                    "BinaryField's default cannot be a string. Use bytes "
+                    fix="BinaryField's default cannot be a string. Use bytes "
                     "content instead.",
                     obj=self,
                     id="fields.filefield_upload_to_not_callable",

plain-models/plain/models/fields/__init__.py

@@ -23,7 +23,7 @@ class JSONField(CheckFieldDefaultMixin, Field):
     default_error_messages = {
         "invalid": "Value must be valid JSON.",
     }
-    _default_hint = ("dict", "{}")
+    _default_fix = ("dict", "{}")
 
     def __init__(
         self,
@@ -60,7 +60,7 @@ def _check_supported(self):
         ):
             errors.append(
                 preflight.PreflightResult(
-                    f"{db_connection.display_name} does not support JSONFields.",
+                    fix=f"{db_connection.display_name} does not support JSONFields. Consider using a TextField with JSON serialization or upgrade to a database that supports JSON fields.",
                     obj=self.model,
                     id="fields.json_field_unsupported",
                 )

plain-models/plain/models/fields/json.py

@@ -29,7 +29,7 @@ def delete_cached_value(self, instance):
 
 
 class CheckFieldDefaultMixin:
-    _default_hint = ("<valid default>", "<invalid default>")
+    _default_fix = ("<valid default>", "<invalid default>")
 
     def _check_default(self):
         if (
@@ -39,11 +39,11 @@ def _check_default(self):
         ):
             return [
                 PreflightResult(
-                    f"{self.__class__.__name__} default should be a callable instead of an instance "
-                    "so that it's not shared between all field instances.",
-                    hint=(
+                    fix=(
+                        f"{self.__class__.__name__} default should be a callable instead of an instance "
+                        "so that it's not shared between all field instances. "
                         "Use a callable instead, e.g., use `{}` instead of "
-                        "`{}`.".format(*self._default_hint)
+                        "`{}`.".format(*self._default_fix)
                     ),
                     obj=self,
                     id="fields.invalid_choice_mixin_default",