Refactoring Forms

[samialfattani]

within the code you could find something like this:

# instead of returning the actual form, it returns the class!
form_class = form.get_form(
            self.model,
            converter,
            base_class=self.form_base_class,
            only=self.column_editable_list,
            field_args=validators,
        )

Here is a checklist of all functions that need to be renamed/refactored into

• Rename BaseModelView.get_form into BaseModelView.get_form_class , to enhance the readability

• Rename
  BaseModelView.get_create_form to BaseModelView.get_create_form_class
BaseModelView.get_edit_form to BaseModelView.get_edit_form_class
BaseModelView.get_delete_form to BaseModelView.get_delete_form_class
BaseModelView.get_action_form to BaseModelView.get_action_form_class

• Rename
  flask_admin.contrib.sqla.form.get_form to flask_admin.contrib.sqla.form.get_form_class
flask_admin.contrib.mongoengine.form.get_form to flask_admin.contrib.mongoengine.form.get_form_class
flask_admin.contrib.peewee.form.get_form to flask_admin.contrib.peewee.form.get_form_class
  to enhance readability

• Rename BaseModelView.scaffold_list_form to BaseModelView.scaffold_editable_list_form

[samuelhwilliams]

Sounds sort of reasonable, just be aware that all of these would be breaking changes so we should follow a deprecation process and then switch over only on a major version bump.

There's a question about whether this is useful enough to justify forcing our users to update their code.

[ElLorans]

I would keep as is, not worth the change IMHO. The type hints and docstrings should help clarify.

[samialfattani]

@samuelhwilliams
@ElLorans

Thanx for your comments, I wanna share my experience when i was try to trace the code i found that it was so confusing to find the right path of creating the form object.

There's a question about whether this is useful enough to justify forcing our users to update their code.

Well maybe you are right, Renaming actually is not the only change i want to do. I want to deprectate unneccessary function by refactoring the design pattern. here is my idea:
What i understood that scaffold_form , get_form , get_create_form ,get_edit_form lead to the same output and we can just combine them into ONE function create_form where it suppose to be responsible of creating form's Class, Object and Caching variable as following:

def create_form(self, obj: t.Any = None, enforce=False) -> Form:
    if self.form :
        return self.form(get_form_data(), obj=obj)
    
    if self._create_form is None or enforce:
      self._create_form = self.scaffold_form()

    return self._create_form(get_form_data(), obj=obj)

# so refreshin cache would be just like this:
def _refresh_forms_cache(self) -> None:
   ...
   self,create_form(enforce=True)
   ....

# and to get the form's class we do like this:
...
self._validate_form_class(self._form_create_rules, self.create_form().__class__)

This way our user will treat with only One funtion to override create_form() and they also still can override scaffold_form() to utilize our Caching mechanism.

Notes:

• I don't know what self.form used for since it does'nt have any reference in whole project. shall we deprecate it ?
• In the create_form(obj), the obj never used in any of this function's call, we can deprecate it or replace it with **kwargs to be passed to the Form's constructor

[ElLorans]

The obj param can be used for customizing the behaviour, I think