mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-21 19:09:18 +01:00
Code Issues Releases Wiki Activity

Refs #26029 -- Extended docs for the StorageHandler default instance.

Browse Source 
Third-party packages that provide storages need to rely on the
StorageHandler API in order to allow users to use the `storages` module
instance to override defaults. Minimally documenting these methods
allows package authors to rely on them.

Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>
This commit is contained in:
Carlton Gibson 2024-10-24 16:57:04 +02:00 committed by GitHub
parent 34066d6cf3
commit 6dcab75d5d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/ref/files/storage.txt
View File

@ -11,7 +11,25 @@ Django provides convenient ways to access the default storage class:
.. data:: storages
Storage instances as defined by :setting:`STORAGES`.
A dictionary-like object that allows retrieving a storage instance using
its alias as defined by :setting:`STORAGES`.
``storages`` has an attribute ``backends``, which defaults to the raw value
provided in :setting:`STORAGES`.
Additionally, ``storages`` provides a ``create_storage()`` method that
accepts the dictionary used in :setting:`STORAGES` for a backend, and
returns a storage instance based on that backend definition. This may be
useful for third-party packages needing to instantiate storages in tests:
.. code-block:: pycon
>>> from django.core.files.storage import storages
>>> storages.backends
{'default': {'BACKEND': 'django.core.files.storage.FileSystemStorage'},
'staticfiles': {'BACKEND': 'django.contrib.staticfiles.storage.StaticFilesStorage'},
'custom': {'BACKEND': 'package.storage.CustomStorage'}}
>>> storage_instance = storages.create_storage({"BACKEND": "package.storage.CustomStorage"})
.. class:: DefaultStorage