FileField – Django Models
Last Updated :
12 Feb, 2020
FileField is a file-upload field. Before uploading files, one needs to specify a lot of settings so that file is securely saved and can be retrieved in a convenient manner. The default form widget for this field is a ClearableFileInput.
Syntax
field_name = models.FileField(upload_to=None, max_length=254, **options)
FileField has an optional arguments:
FileField.upload_to
This attribute provides a way of setting the upload directory and file name, and can be set in two ways. In both cases, the value is passed to the Storage.save() method. If you specify a string value, it may contain strftime() formatting, which will be replaced by the date/time of the file upload (so that uploaded files don’t fill up the given directory). For example:
class MyModel(models.Model):
upload = models.FileField(upload_to ='uploads/')
upload = models.FileField(upload_to ='uploads/% Y/% m/% d/')
|
If you are using the default FileSystemStorage, the string value will be appended to your MEDIA_ROOT path to form the location on the local filesystem where uploaded files will be stored. If you are using different storage, check that storage’s documentation to see how it handles upload_to.
upload_to may also be a callable, such as a function. This will be called to obtain the upload path, including the filename. This callable must accept two arguments and return a Unix-style path (with forward slashes) to be passed along to the storage system. The two arguments are:
| Argument |
Description |
| instance |
An instance of the model where the FileField is defined. More specifically, this is a particular instance where the current file is being attached. |
| filename |
The filename that was originally given to the file. This may or may not be taken into account when determining the final destination path |
For example:
def user_directory_path(instance, filename):
return 'user_{0}/{1}'.format(instance.user.id, filename)
class MyModel(models.Model):
upload = models.FileField(upload_to = user_directory_path)
|
Django Model FileField Explanation
Illustration of FileField using an Example. Consider a project named geeksforgeeks having an app named geeks.
Refer to the following articles to check how to create a project and an app in Django.
Enter the following code into models.py file of geeks app.
from django.db import models
from django.db.models import Model
class GeeksModel(Model):
geeks_field = models.FileField()
|
Add the geeks app to INSTALLED_APPS
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'geeks',
]
|
Now when we run makemigrations command from the terminal,
Python manage.py makemigrations
A new folder named migrations would be created in geeks directory with a file named 0001_initial.py
from django.db import migrations, models
class Migration(migrations.Migration):
initial = True
dependencies = [
]
operations = [
migrations.CreateModel(
name ='GeeksModel',
fields =[
('id',
models.AutoField(
auto_created = True,
primary_key = True,
serialize = False,
verbose_name ='ID'
)),
('geeks_field', models.FileField()),
],
),
]
|
Now run,
Python manage.py migrate
Thus, an geeks_field FileField is created when you run migrations on the project. It is a field to store any kind of file in the database.
How to use FileField ?
FileField is used for storing files into the database. One can any type of file in FileField. Let’s try storing an image in the model created above.
Field Options
Field Options are the arguments given to each field for applying some constraint or imparting a particular characteristic to a particular Field. For example, adding an argument null = True to FileField will enable it to store empty values for that table in relational database.
Here are the field options and attributes that a FileField can use.
| Field Options |
Description |
| Null |
If True, Django will store empty values as NULL in the database. Default is False. |
| Blank |
If True, the field is allowed to be blank. Default is False. |
| db_column |
The name of the database column to use for this field. If this isn’t given, Django will use the field’s name.
|
| Default |
The default value for the field. This can be a value or a callable object. If callable it will be called every time a new object is created.
|
| help_text |
Extra “help” text to be displayed with the form widget. It’s useful for documentation even if your field isn’t used on a form.
|
| primary_key |
If True, this field is the primary key for the model. |
| editable |
If False, the field will not be displayed in the admin or any other ModelForm. They are also skipped during model validation. Default is True.
|
| error_messages |
The error_messages argument lets you override the default messages that the field will raise. Pass in a dictionary with keys matching the error messages you want to override.
|
| help_text |
Extra “help” text to be displayed with the form widget. It’s useful for documentation even if your field isn’t used on a form.
|
| verbose_name |
A human-readable name for the field. If the verbose name isn’t given, Django will automatically create it using the field’s attribute name, converting underscores to spaces.
|
| validators |
A list of validators to run for this field. See the validators documentation for more information.
|
| Unique |
If True, this field must be unique throughout the table.
|
Similar Reads
Django model data types and fields list
The most important part of a model and the only required part of a model is the list of database fields it defines. Fields are specified by class attributes. Be careful not to choose field names that conflict with the models API like clean, save, or delete. Example: from django.db import models clas
4 min read
AutoField - Django Models
According to documentation, An AutoField is an IntegerField that automatically increments according to available IDs. One usually won’t need to use this directly because a primary key field will automatically be added to your model if you don’t specify otherwise. By default, Django gives each model
4 min read
BigAutoField - Django Models
BigAutoField is a 64-bit integer, much like an AutoField except that it is guaranteed to fit numbers from 1 to 9223372036854775807. One can create a BigAutoField using the following syntax, id = models.BigAutoField(primary_key=True, **options) This is an auto-incrementing primary key just like AutoF
4 min read
BigIntegerField - Django Models
BigIntegerField is a 64-bit integer, much like an IntegerField except that it is guaranteed to fit numbers from -9223372036854775808 to 9223372036854775807. The default form widget for this field is a TextInput. Syntax field_name = models.BigIntegerField(**options) Django Model BigIntegerField Expla
4 min read
BinaryField - Django Models
BinaryField is a special field to store raw binary data. It can be assigned bytes, bytearray, or memoryview. By default, BinaryField sets editable to False, that is it can’t be included in a ModelForm. Since BinaryField stores raw data or in other terms a python object, it can not be manually entere
4 min read
BooleanField - Django Models
BooleanField is a true/false field. It is like a bool field in C/C++. The default form widget for this field is CheckboxInput, or NullBooleanSelect if null=True. The default value of BooleanField is None when Field.default isn’t defined. One can define the default value as true or false by setting t
4 min read
CharField - Django Models
CharField is a string field, for small- to large-sized strings. It is like a string field in C/C++. CharField is generally used for storing small strings like first name, last name, etc. To store larger text TextField is used. The default form widget for this field is TextInput. CharField has one ex
4 min read
DateField - Django Models
DateField is a field that stores date, represented in Python by a datetime.date instance. As the name suggests, this field is used to store an object of date created in python. The default form widget for this field is a TextInput. The admin can add a JavaScript calendar and a shortcut for “Today†e
5 min read
DateTimeField - Django Models
DateTimeField is a date and time field which stores date, represented in Python by a datetime.datetime instance. As the name suggests, this field is used to store an object of datetime created in python. The default form widget for this field is a TextInput. The admin uses two separate TextInput wid
5 min read
DecimalField - Django Models
DecimalField is a field which stores a fixed-precision decimal number, represented in Python by a Decimal instance. It validates the input using DecimalValidator. Syntax field_name = models.DecimalField(max_digits=None, decimal_places=None, **options) DecimalField has the following required argument
4 min read