In a Django form how do I make a field readonly or disabled so that it cannot be edited

Question

In a Django form  how do I make a field read-only  or disabled    When the form is being used to create a new entry  all fields should be enabled - but when the record is in update mode some fields need to be read-only   For example  when creating a new Item model  all fields must be editable  but while updating the record  is there a way to disable the sku field so that it is visible  but cannot be edited   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   Can class ItemForm be reused  What changes would be required in the ItemForm or Item model class  Would I need to write another class   ItemUpdateForm   for updating the item   def update item view request       if request method     POST           form   ItemUpdateForm request POST            Validate and save     else          form   ItemUpdateForm

User · Answer

Is this the simplest way   Right in a view code something like this    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    It works fine

User · Answer

I was going into the same problem so I created a Mixin that seems to work for my use cases   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           cleaned data   super ReadOnlyFieldsMixin self  clean           for field in self readonly fields             cleaned data field    getattr self instance  field           return cleaned data   Usage  just define which ones must be read only   class MyFormWithReadOnlyFields ReadOnlyFieldsMixin  MyForm       readonly fields     field1    field2    fieldx

User · Answer

Setting readonly on a widget only makes the input in the browser read-only  Adding a clean sku which returns instance sku ensures the field value will not change on form level   def clean sku self       if self instance           return self instance sku     else           return self fields  sku     This way you can use model s  unmodified save  and avoid getting the field required error

User · Answer

For django 1 9  You can use Fields disabled argument to make field disable  e g  In following code snippet from forms py file   I have made employee code field disabled class EmployeeForm forms ModelForm       employee code   forms CharField disabled True      class Meta          model   Employee         fields     employee code    designation    salary    Reference https   docs djangoproject com en dev ref forms fields  disabled

User · Answer

If you are using Django admin  here is the simplest solution   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

User · Answer

if your need multiple read-only fields you can use any of methods given below   method 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   method 2   inheritance method  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

User · Answer

Based on Yamikep s answer  I found a better and very simple solution which also handles ModelMultipleChoiceField fields   Removing field from form cleaned data prevents fields from being saved   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     Usage   class MyFormWithReadOnlyFields ReadOnlyFieldsMixin  MyForm       readonly fields     field1    field2    fieldx

User · Answer

I ran across a similar problem  It looks like I was able to solve it by defining a  quot get readonly fields quot  method in my ModelAdmin class  Something like this    In the admin py file  class ItemAdmin admin ModelAdmin        def get readonly display self  request  obj None           if obj              return   sku           else              return     The nice thing is that obj will be None when you are adding a new Item  or it will be the object being edited when you are changing an existing Item  get readonly display is documented here  https   docs djangoproject com en dev ref contrib admin  modeladmin-methods

User · Answer

You can elegantly add readonly in the widget  class SurveyModaForm forms ModelForm       class Meta          model    Survey         fields     question no           widgets              question no  forms NumberInput attrs   class   form-control   readonly  True

User · Answer

As pointed out in this answer  Django 1 9 added the Field disabled attribute      The disabled boolean argument  when set to True  disables a form field using the disabled HTML attribute so that it won   t be editable by users  Even if a user tampers with the field   s value submitted to the server  it will be ignored in favor of the value from the form   s initial data    With Django 1 8 and earlier  to disable entry on the widget and prevent malicious POST hacks you must scrub the input in addition to setting the readonly attribute on the form field   class ItemForm ModelForm       def   init   self   args    kwargs           super ItemForm  self    init    args    kwargs          instance   getattr self   instance   None          if instance and instance pk              self fields  sku   widget attrs  readonly     True      def clean sku self           instance   getattr self   instance   None           if instance and instance pk                return instance sku          else                return self cleaned data  sku     Or  replace if instance and instance pk with another condition indicating you re editing   You could also set the attribute disabled on the input field  instead of readonly   The clean sku function will ensure that the readonly value won t be overridden by a POST   Otherwise  there is no built-in Django form field which will render a value while rejecting bound input data   If this is what you desire  you should instead create a separate ModelForm that excludes the uneditable field s   and just print them inside your template

User · Answer

I think your best option would just be to include the readonly attribute in your template rendered in a  lt span gt  or  lt p gt  rather than include it in the form if it s readonly   Forms are for collecting data  not displaying it  That being said  the options to display in a readonly widget and scrub POST data are fine solutions

User · Answer

Two more  similar  approaches with one generalized example   1  first approach - removing field in save   method  e g   not tested        def save self   args    kwargs       for fname in self readonly fields          if fname in self cleaned data              del self cleaned data fname      return super  lt form-name gt   self  save  args   kwargs    2  second approach - reset field to initial value in clean method   def clean  lt fieldname gt  self       return self initial  lt fieldname gt     or getattr self instance  fieldname    Based on second approach I generalized it like this   from functools                 import partial  class  lt Form-name gt             def   init   self                            super  lt Form-name gt   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

User · Answer

For Django 1 2   you can override the field like so   sku   forms CharField widget   forms TextInput attrs   readonly   readonly

User · Answer

One simple option is to just type form instance fieldName in the template instead of form fieldName

User · Answer

Yet again  I am going to offer one more solution    I was using Humphrey s code  so this is based off of that  However  I ran into issues with the field being a ModelChoiceField  Everything would work on the first request  However  if the formset tried to add a new item and failed validation  something was going wrong with the  quot existing quot  forms where the SELECTED option was being reset to the default ---------  Anyway  I couldn t figure out how to fix that  So instead   and I think this is actually cleaner in the form   I made the fields HiddenInputField    This just means you have to do a little more work in the template  So the fix for me was to simplify the Form  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    And then in the template  you ll need to do some manual looping of the formset  So  in this case you would do something like this in the template   lt div gt         form instance sku     lt  -- This prints the value -- gt         form     lt  -- Prints form normally  and makes the hidden input -- gt   lt  div gt   This worked a little better for me and with less form manipulation

User · Answer

I made a MixIn class which you may inherit to be able to add a read only iterable field which will disable and secure fields on the non-first edit    Based on Daniel s and Muhuk s answers   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

User · Answer

I ve just created the simplest possible widget for a readonly field - I don t really see why forms don t have this already   class ReadOnlyWidget widgets Widget          Some of these values are read only - just a bit of text           def render self     value  attrs None           return value   In the form   my read only   CharField widget ReadOnlyWidget      Very simple - and gets me just output  Handy in a formset with a bunch of read only values  Of course - you could also be a bit more clever and give it a div with the attrs so you can append classes to it

User · Answer

Django 1 9 added the Field disabled attribute  https   docs djangoproject com en stable ref forms fields  disabled     The disabled boolean argument  when set to True  disables a form field using the disabled HTML attribute so that it won   t be editable by users  Even if a user tampers with the field   s value submitted to the server  it will be ignored in favor of the value from the form   s initial data

User · Answer

If you are working with Django ver  lt  1 9  the 1 9 has added Field disabled attribute  you could try to add following decorator to your form   init   method   def bound data readonly    initial       return initial   def to python readonly field       native to python   field to python      def to python filed             return native to python field initial       return to python filed   def disable read only fields init method        def init wrapper  args    kwargs           self   args 0          init method  args    kwargs          for field in self fields values                if field widget attrs get  readonly   None                   field widget attrs  disabled     True                 setattr field   bound data   bound data readonly                  setattr field   to python   to python readonly field        return init wrapper   class YourForm forms ModelForm         disable read only fields     def   init   self   args    kwargs                 The main idea is that if field is readonly you don t need any other value except initial   P S  Don t forget to set yuor form field widget attrs  readonly     True

User · Answer

I was going into the same problem so I created a Mixin that seems to work for my use cases   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           cleaned data   super ReadOnlyFieldsMixin self  clean           for field in self readonly fields             cleaned data field    getattr self instance  field           return cleaned data   Usage  just define which ones must be read only   class MyFormWithReadOnlyFields ReadOnlyFieldsMixin  MyForm       readonly fields     field1    field2    fieldx

User · Answer

As a useful addition to Humphrey s post  I had some issues with django-reversion  because it still registered disabled fields as  changed   The following code fixes the problem   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

User · Answer

I ve just created the simplest possible widget for a readonly field - I don t really see why forms don t have this already   class ReadOnlyWidget widgets Widget          Some of these values are read only - just a bit of text           def render self     value  attrs None           return value   In the form   my read only   CharField widget ReadOnlyWidget      Very simple - and gets me just output  Handy in a formset with a bunch of read only values  Of course - you could also be a bit more clever and give it a div with the attrs so you can append classes to it

User · Answer

Setting readonly on a widget only makes the input in the browser read-only  Adding a clean sku which returns instance sku ensures the field value will not change on form level   def clean sku self       if self instance           return self instance sku     else           return self fields  sku     This way you can use model s  unmodified save  and avoid getting the field required error

User · Answer

As pointed out in this answer  Django 1 9 added the Field disabled attribute      The disabled boolean argument  when set to True  disables a form field using the disabled HTML attribute so that it won   t be editable by users  Even if a user tampers with the field   s value submitted to the server  it will be ignored in favor of the value from the form   s initial data    With Django 1 8 and earlier  to disable entry on the widget and prevent malicious POST hacks you must scrub the input in addition to setting the readonly attribute on the form field   class ItemForm ModelForm       def   init   self   args    kwargs           super ItemForm  self    init    args    kwargs          instance   getattr self   instance   None          if instance and instance pk              self fields  sku   widget attrs  readonly     True      def clean sku self           instance   getattr self   instance   None           if instance and instance pk                return instance sku          else                return self cleaned data  sku     Or  replace if instance and instance pk with another condition indicating you re editing   You could also set the attribute disabled on the input field  instead of readonly   The clean sku function will ensure that the readonly value won t be overridden by a POST   Otherwise  there is no built-in Django form field which will render a value while rejecting bound input data   If this is what you desire  you should instead create a separate ModelForm that excludes the uneditable field s   and just print them inside your template

User · Answer

For the Admin version  I think this is a more compact way if you have more than one field   def get readonly fields self  request  obj None       skips     sku    other field       fields   super ItemAdmin  self  get readonly fields request  obj       if not obj          return  field for field in fields if not field in skips      return fields

User · Answer

To make this work for a ForeignKey field  a few changes need to be made   Firstly  the SELECT HTML tag does not have the readonly attribute   We need to use disabled  disabled  instead   However  then the browser doesn t send any form data back for that field   So we need to set that field to not be required so that the field validates correctly   We then need to reset the value back to what it used to be so it s not set to blank     So for foreign keys you will need to do something like   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    This way the browser won t let the user change the field  and will always POST as it it was left blank   We then override the clean method to set the field s value to be what was originally in the instance

User · Answer

I ran across a similar problem  It looks like I was able to solve it by defining a  quot get readonly fields quot  method in my ModelAdmin class  Something like this    In the admin py file  class ItemAdmin admin ModelAdmin        def get readonly display self  request  obj None           if obj              return   sku           else              return     The nice thing is that obj will be None when you are adding a new Item  or it will be the object being edited when you are changing an existing Item  get readonly display is documented here  https   docs djangoproject com en dev ref contrib admin  modeladmin-methods

User · Answer

I think your best option would just be to include the readonly attribute in your template rendered in a  lt span gt  or  lt p gt  rather than include it in the form if it s readonly   Forms are for collecting data  not displaying it  That being said  the options to display in a readonly widget and scrub POST data are fine solutions

User · Answer

Is this the simplest way   Right in a view code something like this    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    It works fine

User · Answer

One simple option is to just type form instance fieldName in the template instead of form fieldName

User · Answer

if your need multiple read-only fields you can use any of methods given below   method 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   method 2   inheritance method  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

User · Answer

For django 1 9  You can use Fields disabled argument to make field disable  e g  In following code snippet from forms py file   I have made employee code field disabled class EmployeeForm forms ModelForm       employee code   forms CharField disabled True      class Meta          model   Employee         fields     employee code    designation    salary    Reference https   docs djangoproject com en dev ref forms fields  disabled

User · Answer

How I do it with 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

User · Answer

Yet again  I am going to offer one more solution    I was using Humphrey s code  so this is based off of that  However  I ran into issues with the field being a ModelChoiceField  Everything would work on the first request  However  if the formset tried to add a new item and failed validation  something was going wrong with the  quot existing quot  forms where the SELECTED option was being reset to the default ---------  Anyway  I couldn t figure out how to fix that  So instead   and I think this is actually cleaner in the form   I made the fields HiddenInputField    This just means you have to do a little more work in the template  So the fix for me was to simplify the Form  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    And then in the template  you ll need to do some manual looping of the formset  So  in this case you would do something like this in the template   lt div gt         form instance sku     lt  -- This prints the value -- gt         form     lt  -- Prints form normally  and makes the hidden input -- gt   lt  div gt   This worked a little better for me and with less form manipulation

User · Answer

If you are using Django admin  here is the simplest solution   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

User · Answer

awalker s answer helped me a lot   I ve changed his example to work with Django 1 3  using get readonly fields   Usually you should declare something like this in app admin py   class ItemAdmin admin ModelAdmin               readonly fields     url      I ve adapted in this way     In the admin py file class ItemAdmin admin ModelAdmin               def get readonly fields self  request  obj None           if obj              return   url           else              return      And it works fine  Now if you add an Item  the url field is read-write  but on change it becomes read-only

User · Answer

As pointed out in this answer  Django 1 9 added the Field disabled attribute      The disabled boolean argument  when set to True  disables a form field using the disabled HTML attribute so that it won   t be editable by users  Even if a user tampers with the field   s value submitted to the server  it will be ignored in favor of the value from the form   s initial data    With Django 1 8 and earlier  to disable entry on the widget and prevent malicious POST hacks you must scrub the input in addition to setting the readonly attribute on the form field   class ItemForm ModelForm       def   init   self   args    kwargs           super ItemForm  self    init    args    kwargs          instance   getattr self   instance   None          if instance and instance pk              self fields  sku   widget attrs  readonly     True      def clean sku self           instance   getattr self   instance   None           if instance and instance pk                return instance sku          else                return self cleaned data  sku     Or  replace if instance and instance pk with another condition indicating you re editing   You could also set the attribute disabled on the input field  instead of readonly   The clean sku function will ensure that the readonly value won t be overridden by a POST   Otherwise  there is no built-in Django form field which will render a value while rejecting bound input data   If this is what you desire  you should instead create a separate ModelForm that excludes the uneditable field s   and just print them inside your template

User · Answer

For the Admin version  I think this is a more compact way if you have more than one field   def get readonly fields self  request  obj None       skips     sku    other field       fields   super ItemAdmin  self  get readonly fields request  obj       if not obj          return  field for field in fields if not field in skips      return fields

User · Answer

As I can t yet comment  muhuk s solution   I ll response as a separate answer  This is a complete code example  that worked for me   def clean sku self     if self instance and self instance pk      return self instance sku   else      return self cleaned data  sku

User · Answer

Setting readonly on a widget only makes the input in the browser read-only  Adding a clean sku which returns instance sku ensures the field value will not change on form level   def clean sku self       if self instance           return self instance sku     else           return self fields  sku     This way you can use model s  unmodified save  and avoid getting the field required error

User · Answer

To make this work for a ForeignKey field  a few changes need to be made   Firstly  the SELECT HTML tag does not have the readonly attribute   We need to use disabled  disabled  instead   However  then the browser doesn t send any form data back for that field   So we need to set that field to not be required so that the field validates correctly   We then need to reset the value back to what it used to be so it s not set to blank     So for foreign keys you will need to do something like   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    This way the browser won t let the user change the field  and will always POST as it it was left blank   We then override the clean method to set the field s value to be what was originally in the instance

User · Answer

Here is a slightly more involved version  based on christophe31 s answer  It does not rely on the  readonly  attribute  This makes its problems  like select boxes still being changeable and datapickers still popping up  go away   Instead  it wraps the form fields widget in a readonly widget  thus making the form still validate  The content of the original widget is displayed inside  lt span class  hidden  gt  lt  span gt  tags  If the widget has a render readonly   method it uses that as the visible text  otherwise it parses the HTML of the original widget and tries to guess the best representation   import django forms widgets as f import xml etree ElementTree as etree from django utils safestring import mark safe  def make readonly form               Makes all fields on the form readonly and prevents it from POST hacks               def  get cleaner  form  field           def clean field                return getattr  form instance  field  None          return clean field      for field name in form fields keys            form fields field name  widget   ReadOnlyWidget              initial widget form fields field name  widget          setattr form   clean     field name                    get cleaner form  field name        form is readonly   True  class ReadOnlyWidget f Select               Renders the content of the initial widget in a hidden  lt span gt   If the     initial widget has a   render readonly     method it uses that as display     text  otherwise it tries to guess by parsing the html of the initial widget               def   init   self  initial widget   args    kwargs           self initial widget   initial widget         super ReadOnlyWidget  self    init    args    kwargs       def render self   args    kwargs           def guess readonly text original content               root   etree fromstring   lt span gt  s lt  span gt     original content               for element in root                  if element tag     input                       return element get  value                    if element tag     select                       for option in element                          if option get  selected                                return option text                  if element tag     textarea                       return element text              return  N A           original content   self initial widget render  args    kwargs          try              readonly text   self initial widget render readonly  args    kwargs          except AttributeError              readonly text   guess readonly text original content           return mark safe     lt span class  hidden  gt  s lt  span gt  s                    original content  readonly text      Usage example 1  self fields  my field   widget   ReadOnlyWidget self fields  my field   widget     Usage example 2  form   MyForm   make readonly form

User · Answer

As a useful addition to Humphrey s post  I had some issues with django-reversion  because it still registered disabled fields as  changed   The following code fixes the problem   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

User · Answer

If you are working with Django ver  lt  1 9  the 1 9 has added Field disabled attribute  you could try to add following decorator to your form   init   method   def bound data readonly    initial       return initial   def to python readonly field       native to python   field to python      def to python filed             return native to python field initial       return to python filed   def disable read only fields init method        def init wrapper  args    kwargs           self   args 0          init method  args    kwargs          for field in self fields values                if field widget attrs get  readonly   None                   field widget attrs  disabled     True                 setattr field   bound data   bound data readonly                  setattr field   to python   to python readonly field        return init wrapper   class YourForm forms ModelForm         disable read only fields     def   init   self   args    kwargs                 The main idea is that if field is readonly you don t need any other value except initial   P S  Don t forget to set yuor form field widget attrs  readonly     True

User · Answer

As pointed out in this answer  Django 1 9 added the Field disabled attribute      The disabled boolean argument  when set to True  disables a form field using the disabled HTML attribute so that it won   t be editable by users  Even if a user tampers with the field   s value submitted to the server  it will be ignored in favor of the value from the form   s initial data    With Django 1 8 and earlier  to disable entry on the widget and prevent malicious POST hacks you must scrub the input in addition to setting the readonly attribute on the form field   class ItemForm ModelForm       def   init   self   args    kwargs           super ItemForm  self    init    args    kwargs          instance   getattr self   instance   None          if instance and instance pk              self fields  sku   widget attrs  readonly     True      def clean sku self           instance   getattr self   instance   None           if instance and instance pk                return instance sku          else                return self cleaned data  sku     Or  replace if instance and instance pk with another condition indicating you re editing   You could also set the attribute disabled on the input field  instead of readonly   The clean sku function will ensure that the readonly value won t be overridden by a POST   Otherwise  there is no built-in Django form field which will render a value while rejecting bound input data   If this is what you desire  you should instead create a separate ModelForm that excludes the uneditable field s   and just print them inside your template

User · Answer

Two more  similar  approaches with one generalized example   1  first approach - removing field in save   method  e g   not tested        def save self   args    kwargs       for fname in self readonly fields          if fname in self cleaned data              del self cleaned data fname      return super  lt form-name gt   self  save  args   kwargs    2  second approach - reset field to initial value in clean method   def clean  lt fieldname gt  self       return self initial  lt fieldname gt     or getattr self instance  fieldname    Based on second approach I generalized it like this   from functools                 import partial  class  lt Form-name gt             def   init   self                            super  lt Form-name gt   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

User · Answer

Setting readonly on a widget only makes the input in the browser read-only  Adding a clean sku which returns instance sku ensures the field value will not change on form level   def clean sku self       if self instance           return self instance sku     else           return self fields  sku     This way you can use model s  unmodified save  and avoid getting the field required error

User · Answer

How I do it with 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

User · Answer

Here is a slightly more involved version  based on christophe31 s answer  It does not rely on the  readonly  attribute  This makes its problems  like select boxes still being changeable and datapickers still popping up  go away   Instead  it wraps the form fields widget in a readonly widget  thus making the form still validate  The content of the original widget is displayed inside  lt span class  hidden  gt  lt  span gt  tags  If the widget has a render readonly   method it uses that as the visible text  otherwise it parses the HTML of the original widget and tries to guess the best representation   import django forms widgets as f import xml etree ElementTree as etree from django utils safestring import mark safe  def make readonly form               Makes all fields on the form readonly and prevents it from POST hacks               def  get cleaner  form  field           def clean field                return getattr  form instance  field  None          return clean field      for field name in form fields keys            form fields field name  widget   ReadOnlyWidget              initial widget form fields field name  widget          setattr form   clean     field name                    get cleaner form  field name        form is readonly   True  class ReadOnlyWidget f Select               Renders the content of the initial widget in a hidden  lt span gt   If the     initial widget has a   render readonly     method it uses that as display     text  otherwise it tries to guess by parsing the html of the initial widget               def   init   self  initial widget   args    kwargs           self initial widget   initial widget         super ReadOnlyWidget  self    init    args    kwargs       def render self   args    kwargs           def guess readonly text original content               root   etree fromstring   lt span gt  s lt  span gt     original content               for element in root                  if element tag     input                       return element get  value                    if element tag     select                       for option in element                          if option get  selected                                return option text                  if element tag     textarea                       return element text              return  N A           original content   self initial widget render  args    kwargs          try              readonly text   self initial widget render readonly  args    kwargs          except AttributeError              readonly text   guess readonly text original content           return mark safe     lt span class  hidden  gt  s lt  span gt  s                    original content  readonly text      Usage example 1  self fields  my field   widget   ReadOnlyWidget self fields  my field   widget     Usage example 2  form   MyForm   make readonly form

User · Answer

awalker s answer helped me a lot   I ve changed his example to work with Django 1 3  using get readonly fields   Usually you should declare something like this in app admin py   class ItemAdmin admin ModelAdmin               readonly fields     url      I ve adapted in this way     In the admin py file class ItemAdmin admin ModelAdmin               def get readonly fields self  request  obj None           if obj              return   url           else              return      And it works fine  Now if you add an Item  the url field is read-write  but on change it becomes read-only

User · Answer

Based on Yamikep s answer  I found a better and very simple solution which also handles ModelMultipleChoiceField fields   Removing field from form cleaned data prevents fields from being saved   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     Usage   class MyFormWithReadOnlyFields ReadOnlyFieldsMixin  MyForm       readonly fields     field1    field2    fieldx

User · Answer

For Django 1 2   you can override the field like so   sku   forms CharField widget   forms TextInput attrs   readonly   readonly

User · Answer

I made a MixIn class which you may inherit to be able to add a read only iterable field which will disable and secure fields on the non-first edit    Based on Daniel s and Muhuk s answers   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

User · Answer

As I can t yet comment  muhuk s solution   I ll response as a separate answer  This is a complete code example  that worked for me   def clean sku self     if self instance and self instance pk      return self instance sku   else      return self cleaned data  sku

User · Answer

You can elegantly add readonly in the widget  class SurveyModaForm forms ModelForm       class Meta          model    Survey         fields     question no           widgets              question no  forms NumberInput attrs   class   form-control   readonly  True

User · Answer

Django 1 9 added the Field disabled attribute  https   docs djangoproject com en stable ref forms fields  disabled     The disabled boolean argument  when set to True  disables a form field using the disabled HTML attribute so that it won   t be editable by users  Even if a user tampers with the field   s value submitted to the server  it will be ignored in favor of the value from the form   s initial data

[django] In a Django form, how do I make a field readonly (or disabled) so that it cannot be edited?

Examples related to django

Examples related to forms

Examples related to field

Examples related to readonly