FilePathField – Django Models

FilePathField is a CharField whose choices are limited to the filenames in a certain directory on the filesystem. FilePathField instances are created in your database as varchar columns with a default max length of 100 characters.

Syntax:

field_name = models.FilePathField(path=None, match=None, recursive=False, max_length=100, **options)



FilePathField has following special arguments, of which the first is required:

  • FilePathField.path – This attribute is required. The absolute filesystem path to a directory from which this FilePathField should get its choices. Example: "/home/images".
  • FilePathField.match – A regular expression, as a string, that FilePathField will use to filter filenames. Note that the regex will be applied to the base filename, not the full path. Example: “foo.*\.txt$”, which will match a file called foo23.txt but not bar.txt or foo23.png.
  • FilePathField.recursive – Either True or False. Default is False. Specifies whether all subdirectories of path should be included
  • FilePathField.allow_files – Either True or False. Default is True. Specifies whether files in the specified location should be included. Either this or allow_folders must be True.
  • FilePathField.allow_folders – Either True or False. Default is False. Specifies whether folders in the specified location should be included. Either this or allow_files must be True.

The one major point to consider is that match applies to the base filename, not the full path. So, this example:

filter_none

edit
close

play_arrow

link
brightness_4
code

FilePathField(path ="/home/images",
              match ="foo.*"
              recursive = True)

chevron_right


…will match /home/images/foo.png but not /home/images/foo/bar.png because the match applies to the base filename (foo.png and bar.png).

Django Model FilePathField Explanation

Illustration of FilePathField 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.

filter_none

edit
close

play_arrow

link
brightness_4
code

from django.db import models
from django.db.models import Model
# Create your models here.
  
class GeeksModel(Model):
    geeks_field = models.FilePathField(path ="/home/naveen/projects/geeksforgeeks/images")

chevron_right


Add the geeks app to INSTALLED_APPS

filter_none

edit
close

play_arrow

link
brightness_4
code

# Application definition
  
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'geeks',
]

chevron_right


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

filter_none

edit
close

play_arrow

link
brightness_4
code

# Generated by Django 2.2.5 on 2019-09-25 06:00
  
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.FilePathField(
                 path ="/home/naveen/projects/geeksforgeeks/images")),
            ],
        ),
    ]

chevron_right


Now run,

Python manage.py migrate

Thus, an geeks_field FilePathField 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 FilePathField ?

FilePathField is used for storing files into the database. One can any type of file in FilePathField. Let’s try storing an image in the model created above.

  • To start creating instances of model, create an admin account by using the following command.
    Python manage.py createsuperuser
  • Enter a username, email and a secure password. Then in your browser enter the following URL.
    http://localhost:8000/admin/

    filefield-django-models-1

  • Go to add in front of Geeks Models.
    django-filepathfield-models
  • Choose the file you want to upload and click on save. Now let’s check it in admin server. We have created an instance of GeeksModel.
    FilePathField django models

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 FilePathField will enable it to store empty values for that table in relational database.
Here are the field options and attributes that a FilePathField 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.



My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.



Improved By : NaveenArora

Article Tags :

Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.