Skip to main content

A Django storage backend that names files by hash value.

Project description

https://travis-ci.org/ecometrica/django-hashedfilenamestorage.svg?branch=master

django-hashedfilenamestorage

A Django storage backend that names files by hash value.

By default, django.core.files.storage.FileSystemStorage deals with conflicting filenames by appending an underscore and a random 7 character alphanumeric string to the file. For instance, if you try to create hello.txt when it already exists, it will rename it as e.g. hello_a12mkj3.txt.

django-hashedfilenamestorage creates hashed filenames, so if you try to create hello.txt with the content Hello world!, it will save it as d3486ae9136e7856bc42212385ea797094475802.txt. Directory names and extensions are preserved, only the root filename is changed. This reduces the number of duplicates stored in the underlying backend, and implies that these files can be served from a static cache that never expires.

Installing

The easiest way to install django-hashedfilenamestorage is to use pip:

pip install django-hashedfilenamestorage

Quick Start

In your Django settings file:

  • Set DEFAULT_FILE_STORAGE to 'django_hashedfilenamestorage.storage.HashedFilenameFileSystemStorage'

This gives you hashed filenames, backed on Django’s FileSystemStorage storage class.

HashedFilenameMetaStorage

You can define a new underlying storage class by using HashedFilenameMetaStorage to wrap it:

from django.core.files.storage import get_storage_class

from django_hashedfilenamestorage.storage import HashedFilenameMetaStorage

HashedFilenameMyStorage = HashedFilenameMetaStorage(
    storage_class=get_storage_class('myapp.storage.MyStorage'),
)

Hashing algorithm

HashedFilenameMetaStorage is meant to generate duplicate filenames for files with identical contents. To do this, it reads the contents of the file and generates a SHA-1 hash of them.

Filenames have their extensions preserved, so it is possible to have duplicate contents on the filesystem, but it is important to help serve files with their proper content types.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-hashedfilenamestorage-2.0.tar.gz (4.7 kB view details)

Uploaded Source

File details

Details for the file django-hashedfilenamestorage-2.0.tar.gz.

File metadata

File hashes

Hashes for django-hashedfilenamestorage-2.0.tar.gz
Algorithm Hash digest
SHA256 e71bf9e34c8aa344495332288688f49501e8d59e5deb08edc79182614cada71b
MD5 8f6b5097ceb2b9b828d94925812dd938
BLAKE2b-256 dcb9f2fa1d623dabf7098c5833d6ac7b30066ec6b4eb3d95372fe949d2af1514

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page