Администратор Flask отображает значение перечисления вместо имени

У меня есть модель, которая использует перечисление для определения уровня доступа следующим образом:

class DevelModelView(ModelView):
    edit_modal = True

    def is_accessible(self):
        return current_user.is_authenticated and current_user.access is AccessLevel.DEVEL

class DevelStaffModelView(DevelModelView):
    column_editable_list = ['access']
    column_filters = ['access']
    column_searchable_list = ['login', 'email']
    form_choices = {'access': [(AccessLevel.DEVEL.name, AccessLevel.DEVEL.value),
                               (AccessLevel.ADMIN.name, AccessLevel.ADMIN.value),
                               (AccessLevel.STAFF.name, AccessLevel.STAFF.value)]}

Определение перечисления ниже...

class AccessLevel(Enum):
    DEVEL = 'Developer'
    ADMIN = 'Administrator'
    STAFF = 'Staff Member'

Используя атрибут form_choices, я смог отобразить как модальный, так и редактируемый выбор столбца в форме значения (IE: Developer), но, к сожалению, отображение по-прежнему использует имя (IE: Name).

Чтобы уточнить, я, по сути, спрашиваю, есть ли возможность, чтобы администратор Flask отображал значение перечисления, а не имя по умолчанию в таблице отображения. Заранее спасибо...

Также предоставление модели персонала на всякий случай, если это будет полезно...

class Staff(db.Model, UserMixin):
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    login = db.Column(db.String(64), unique=True)
    _password = db.Column(db.String(128))
    email = db.Column(db.String(100))
    access = db.Column('access', db.Enum(AccessLevel))

    @hybrid_property
    def password(self):
        return self._password

    @password.setter
    def password(self, plaintext):
        self._password = bcrypt.generate_password_hash(plaintext)

    def check_password(self, plaintext):
        return bcrypt.check_password_hash(self._password, plaintext)

    def __str__(self):
        return "%s: %s (%s)" % (self.access.name, self.login, self.email)

🤔 А знаете ли вы, что...
Flask - это микрофреймворк для создания веб-приложений на языке Python.


1
1 529
2

Ответы:

Вам нужна функциональность column_formatters для отображения правильных значений в таблице. Функция форматирования определяется следующим образом:

def access_level_formatter(view, context, model, name):
    db_value = getattr(model, name)
    enum_value = getattr(AccessLevel, db_value)
    return enum_value.value

И вам нужно указать этот форматер в классе представления, что он используется для столбца access:

class DevelStaffModelView(DevelModelView):
    column_formatters = {
        'access': access_level_formatter,
    }

Решено

Если у вас есть несколько типов enum для отображения, вместо того, чтобы создавать отдельные column_formatters, вы можете обновить column_type_formatters, который использует Flask-Admin.

Пример

from flask_admin.model import typefmt


class AccessLevel(Enum):
    DEVEL = 'Developer'
    ADMIN = 'Administrator'
    STAFF = 'Staff Member'

# ...

MY_DEFAULT_FORMATTERS = dict(typefmt.BASE_FORMATTERS)

MY_DEFAULT_FORMATTERS.update({
   AccessLevel: lambda view, access_level_enum: access_level_enum.value  # could use a function here
})


class DevelModelView(ModelView):

    column_type_formatters = MY_DEFAULT_FORMATTERS

    #  ...

Также рассмотрите возможность настройки вариантов AccessLevel, как описано в этом ТАК ответ. Это означает, что вам не нужно повторять имя/значения перечисления в определении представления вашей модели. Обратите внимание на методы __str__ и __html__ в классе AccessLevel.

Пример

from flask_admin.model import typefmt
from wtforms import SelectField


class AccessLevel(Enum):
    DEVEL = 'Developer'
    ADMIN = 'Administrator'
    STAFF = 'Staff Member'

    def __str__(self):
        return self.name  # value string

    def __html__(self):
        return self.value  # option labels


def enum_field_options(enum):
    """Produce WTForm Field instance configuration options for an Enum

    Returns a dictionary with 'choices' and 'coerce' keys, use this as
    **enum_fields_options(EnumClass) when constructing a field:

    enum_selection = SelectField("Enum Selection", **enum_field_options(EnumClass))

    Labels are produced from enum_instance.__html__() or
    str(eum_instance), value strings with str(enum_instance).

    """
    assert not {'__str__', '__html__'}.isdisjoint(vars(enum)), (
        "The {!r} enum class does not implement a __str__ or __html__ method")

    def coerce(name):
        if isinstance(name, enum):
            # already coerced to instance of this enum
            return name
        try:
            return enum[name]
        except KeyError:
            raise ValueError(name)

    return dict(choices=[(v, v) for v in enum], coerce=coerce)


class DevelModelView(ModelView):

    column_type_formatters = MY_DEFAULT_FORMATTERS

    #  ...

    form_overrides = {
        'access': SelectField,
    }

    form_args = {
        'access': enum_field_options(AccessLevel),
    }

    # ...