fields - django model read only field




En un formulario Django, ¿cómo hago un campo de solo lectura(o deshabilitado) para que no pueda editarse? (18)

¿Es esta la forma más sencilla?

Justo en un código de vista algo como esto:

def resume_edit(request, r_id):
    .....    
    r = Resume.get.object(pk=r_id)
    resume = ResumeModelForm(instance=r)
    .....
    resume.fields['email'].widget.attrs['readonly'] = True 
    .....
    return render(request, 'resumes/resume.html', context)

¡Funciona bien!

En un formulario Django, ¿cómo hago un campo de solo lectura (o deshabilitado)?

Cuando se usa el formulario para crear una nueva entrada, todos los campos deben estar habilitados, pero cuando el registro está en modo de actualización, algunos campos deben ser de solo lectura.

Por ejemplo, al crear un nuevo modelo de Item , todos los campos deben ser editables, pero al actualizar el registro, ¿hay una manera de deshabilitar el campo sku para que esté visible, pero no se pueda editar?

class Item(models.Model):
    sku = models.CharField(max_length=50)
    description = models.CharField(max_length=200)
    added_by = models.ForeignKey(User)


class ItemForm(ModelForm):
    class Meta:
        model = Item
        exclude = ('added_by')

def new_item_view(request):
    if request.method == 'POST':
        form = ItemForm(request.POST)
        # Validate and save
    else:
            form = ItemForm()
    # Render the view

¿ ItemForm puede reutilizar la clase ItemForm ? ¿Qué cambios serían necesarios en la clase de modelo ItemForm o Item ? ¿Necesitaría escribir otra clase, " ItemUpdateForm ", para actualizar el artículo?

def update_item_view(request):
    if request.method == 'POST':
        form = ItemUpdateForm(request.POST)
        # Validate and save
    else:
        form = ItemUpdateForm()

Acabo de crear el widget más simple posible para un campo de solo lectura. Realmente no veo por qué los formularios aún no tienen esto:

class ReadOnlyWidget(widgets.Widget):
    """Some of these values are read only - just a bit of text..."""
    def render(self, _, value, attrs=None):
        return value

En la forma:

my_read_only = CharField(widget=ReadOnlyWidget())

Muy simple - y me acaba de dar salida. Práctico en un conjunto de formas con un montón de valores de solo lectura. Por supuesto, también podría ser un poco más inteligente y darle un div con los atributos para poder agregarle clases.


Basándome en la respuesta de Yamikep , encontré una solución mejor y muy simple que también maneja los campos ModelMultipleChoiceField .

Eliminar el campo de form.cleaned_data evita que los campos se guarden:

class ReadOnlyFieldsMixin(object):
    readonly_fields = ()

    def __init__(self, *args, **kwargs):
        super(ReadOnlyFieldsMixin, self).__init__(*args, **kwargs)
        for field in (field for name, field in self.fields.iteritems() if
                      name in self.readonly_fields):
            field.widget.attrs['disabled'] = 'true'
            field.required = False

    def clean(self):
        for f in self.readonly_fields:
            self.cleaned_data.pop(f, None)
        return super(ReadOnlyFieldsMixin, self).clean()

Uso:

class MyFormWithReadOnlyFields(ReadOnlyFieldsMixin, MyForm):
    readonly_fields = ('field1', 'field2', 'fieldx')

Cómo lo hago con Django 1.11:

class ItemForm(ModelForm):
    disabled_fields = ('added_by',)

    class Meta:
        model = Item
        fields = '__all__'

    def __init__(self, *args, **kwargs):
        super(ItemForm, self).__init__(*args, **kwargs)
        for field in self.disabled_fields:
            self.fields[field].disabled = True

Como todavía no puedo comentar ( la solución de muhuk ), responderé como una respuesta separada. Este es un ejemplo de código completo, que funcionó para mí:

def clean_sku(self):
  if self.instance and self.instance.pk:
    return self.instance.sku
  else:
    return self.cleaned_data['sku']

Como una adición útil a la publicación de Humphrey , tuve algunos problemas con django-reversion, porque todavía registra campos deshabilitados como "cambiados". El siguiente código soluciona el problema.

class ItemForm(ModelForm):

    def __init__(self, *args, **kwargs):
        super(ItemForm, self).__init__(*args, **kwargs)
        instance = getattr(self, 'instance', None)
        if instance and instance.id:
            self.fields['sku'].required = False
            self.fields['sku'].widget.attrs['disabled'] = 'disabled'

    def clean_sku(self):
        # As shown in the above answer.
        instance = getattr(self, 'instance', None)
        if instance:
            try:
                self.changed_data.remove('sku')
            except ValueError, e:
                pass
            return instance.sku
        else:
            return self.cleaned_data.get('sku', None)

Django 1.9 agregó el atributo Field.disabled: Field.disabled

El argumento booleano deshabilitado, cuando se establece en Verdadero, deshabilita un campo de formulario usando el atributo HTML deshabilitado para que los usuarios no puedan editarlo. Incluso si un usuario manipula el valor del campo enviado al servidor, se ignorará a favor del valor de los datos iniciales del formulario.


Dos enfoques más (similares) con un ejemplo generalizado:

1) primer acercamiento: eliminación del campo en el método save (), por ejemplo (no probado):

def save(self, *args, **kwargs):
    for fname in self.readonly_fields:
        if fname in self.cleaned_data:
            del self.cleaned_data[fname]
    return super(<form-name>, self).save(*args,**kwargs)

2) segundo enfoque: reajuste el campo al valor inicial en el método de limpieza:

def clean_<fieldname>(self):
    return self.initial[<fieldname>] # or getattr(self.instance, fieldname)

Basado en el segundo enfoque lo generalicé así:

from functools                 import partial

class <Form-name>(...):

    def __init__(self, ...):
        ...
        super(<Form-name>, self).__init__(*args, **kwargs)
        ...
        for i, (fname, field) in enumerate(self.fields.iteritems()):
            if fname in self.readonly_fields:
                field.widget.attrs['readonly'] = "readonly"
                field.required = False
                # set clean method to reset value back
                clean_method_name = "clean_%s" % fname
                assert clean_method_name not in dir(self)
                setattr(self, clean_method_name, partial(self._clean_for_readonly_field, fname=fname))

    def _clean_for_readonly_field(self, fname):
        """ will reset value to initial - nothing will be changed 
            needs to be added dynamically - partial, see init_fields
        """
        return self.initial[fname] # or getattr(self.instance, fieldname)

Hice una clase MixIn que puede heredar para poder agregar un campo iterable read_only que deshabilitará y protegerá los campos en la primera edición:

(Basado en las respuestas de Daniel y Muhuk)

from django import forms
from django.db.models.manager import Manager

# I used this instead of lambda expression after scope problems
def _get_cleaner(form, field):
    def clean_field():
         value = getattr(form.instance, field, None)
         if issubclass(type(value), Manager):
             value = value.all()
         return value
    return clean_field

class ROFormMixin(forms.BaseForm):
    def __init__(self, *args, **kwargs):
        super(ROFormMixin, self).__init__(*args, **kwargs)
        if hasattr(self, "read_only"):
            if self.instance and self.instance.pk:
                for field in self.read_only:
                    self.fields[field].widget.attrs['readonly'] = "readonly"
                    setattr(self, "clean_" + field, _get_cleaner(self, field))

# Basic usage
class TestForm(AModelForm, ROFormMixin):
    read_only = ('sku', 'an_other_field')

La configuración de READONLY en el widget solo hace que la entrada del navegador sea de solo lectura. Al agregar un clean_sku que devuelve instance.sku, se garantiza que el valor del campo no cambiará en el nivel del formulario.

def clean_sku(self):
    if self.instance: 
        return self.instance.sku
    else: 
        return self.fields['sku']

De esta manera, puede usar el modelo (guardar sin modificar) y aviod para obtener el error de campo requerido.


Para Django 1.2+, puedes anular el campo así:

sku = forms.CharField(widget = forms.TextInput(attrs={'readonly':'readonly'}))

Para Django 1.9+
Puede usar el argumento Campos deshabilitados para deshabilitar el campo. por ejemplo, en el siguiente fragmento de código del archivo forms.py, he desactivado el campo employee_code

class EmployeeForm(forms.ModelForm):
    employee_code = forms.CharField(disabled=True)
    class Meta:
        model = Employee
        fields = ('employee_code', 'designation', 'salary')

Consulte https://docs.djangoproject.com/en/2.0/ref/forms/fields/#disabled


Para que esto funcione en un campo ForeignKey, es necesario realizar algunos cambios. En primer lugar, la etiqueta SELECT HTML no tiene el atributo de solo lectura. Necesitamos usar disabled = "disabled" en su lugar. Sin embargo, entonces el navegador no envía ningún dato de formulario para ese campo. Por lo tanto, debemos configurar ese campo para que no sea necesario para que el campo se valide correctamente. Entonces necesitamos restablecer el valor a lo que solía ser para que no esté en blanco.

Así que para las claves foráneas necesitarás hacer algo como:

class ItemForm(ModelForm):

    def __init__(self, *args, **kwargs):
        super(ItemForm, self).__init__(*args, **kwargs)
        instance = getattr(self, 'instance', None)
        if instance and instance.id:
            self.fields['sku'].required = False
            self.fields['sku'].widget.attrs['disabled'] = 'disabled'

    def clean_sku(self):
        # As shown in the above answer.
        instance = getattr(self, 'instance', None)
        if instance:
            return instance.sku
        else:
            return self.cleaned_data.get('sku', None)

De esta manera, el navegador no permitirá que el usuario cambie el campo, y siempre POSTARÁ, ya que se dejó en blanco. Luego, anulamos el método de limpieza para establecer que el valor del campo sea lo que originalmente estaba en la instancia.


Resolví este problema así:

    class UploadFileForm(forms.ModelForm):
     class Meta:
      model = FileStorage
      fields = '__all__'
      widgets = {'patient': forms.HiddenInput()}

en vistas:

form = UploadFileForm(request.POST, request.FILES, instance=patient, initial={'patient': patient})

Es todo


Si está utilizando el administrador de Django, esta es la solución más sencilla.

class ReadonlyFieldsMixin(object):
    def get_readonly_fields(self, request, obj=None):
        if obj:
            return super(ReadonlyFieldsMixin, self).get_readonly_fields(request, obj)
        else:
            return tuple()

class MyAdmin(ReadonlyFieldsMixin, ModelAdmin):
    readonly_fields = ('sku',)

Si necesita varios campos de solo lectura. Puede utilizar cualquiera de los métodos que se indican a continuación.

Método 1

class ItemForm(ModelForm):
    readonly = ('sku',)

    def __init__(self, *arg, **kwrg):
        super(ItemForm, self).__init__(*arg, **kwrg)
        for x in self.readonly:
            self.fields[x].widget.attrs['disabled'] = 'disabled'

    def clean(self):
        data = super(ItemForm, self).clean()
        for x in self.readonly:
            data[x] = getattr(self.instance, x)
        return data

método 2

método de herencia

class AdvancedModelForm(ModelForm):


    def __init__(self, *arg, **kwrg):
        super(AdvancedModelForm, self).__init__(*arg, **kwrg)
        if hasattr(self, 'readonly'):
            for x in self.readonly:
                self.fields[x].widget.attrs['disabled'] = 'disabled'

    def clean(self):
        data = super(AdvancedModelForm, self).clean()
        if hasattr(self, 'readonly'):
            for x in self.readonly:
                data[x] = getattr(self.instance, x)
        return data


class ItemForm(AdvancedModelForm):
    readonly = ('sku',)

Una vez más, voy a ofrecer una solución más :) Estaba usando el código de Humphrey , así que esto se basa en eso.

Sin embargo, me encontré con problemas con el campo siendo un ModelChoiceField. Todo funcionaría en la primera petición. Sin embargo, si el formset intentó agregar un nuevo elemento y falló la validación, algo salió mal con los formularios "existentes" en los que la opción SELECTED se estaba restableciendo al valor predeterminado "---------".

De todos modos, no pude averiguar cómo arreglar eso. Entonces, en lugar de eso, (y creo que esto está realmente más limpio en el formulario), hice los campos HiddenInputField (). Esto solo significa que tienes que hacer un poco más de trabajo en la plantilla.

Así que la solución para mí fue simplificar el formulario:

class ItemForm(ModelForm):

    def __init__(self, *args, **kwargs):
        super(ItemForm, self).__init__(*args, **kwargs)
        instance = getattr(self, 'instance', None)
        if instance and instance.id:
            self.fields['sku'].widget=HiddenInput()

Y luego en la plantilla, necesitarás hacer algunos bucles manuales de formset .

Entonces, en este caso, harías algo como esto en la plantilla:

<div>
    {{ form.instance.sku }} <!-- This prints the value -->
    {{ form }} <!-- Prints form normally, and makes the hidden input -->
</div>

Esto funcionó un poco mejor para mí y con menos manipulación de formas.


¡La respuesta de Awalker me ayudó mucho!

He cambiado su ejemplo para trabajar con Django 1.3, usando get_readonly_fields .

Por lo general, deberías declarar algo como esto en app/admin.py :

class ItemAdmin(admin.ModelAdmin):
    ...
    readonly_fields = ('url',)

Me he adaptado de esta manera:

# In the admin.py file
class ItemAdmin(admin.ModelAdmin):
    ...
    def get_readonly_fields(self, request, obj=None):
        if obj:
            return ['url']
        else:
            return []

Y funciona bien. Ahora, si agrega un elemento, el campo url es de lectura y escritura, pero al cambiar se convierte en de solo lectura.