Apparent discrepancy between online documentation and how the code works for custom File Storage system
|Reported by:||xhad||Owned by:||Jacob|
|Severity:||Keywords:||file storage, documentation|
|Has patch:||no||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
The online documentation for writing custom File Storage systems says that the
_save method must be overridden and "No return value is expected." (http://docs.djangoproject.com/en/dev/howto/custom-file-storage/#save-name-content).
However, the inherited
save method in
django/core/files/storage.py contains these lines (45-48):
name = self._save(name, content) # Store filenames with forward slashes, even on Windows return force_unicode(name.replace('\\', '/'))
The obvious problem is that returning nothing from the
_save method causes the last line to throw an error like this:
AttributeError: 'NoneType' object has no attribute 'replace'
From what I can tell, the documentation should state that the
_save method should be implemented so that it returns the name of the file that was written to in the end. This seems to be consistent with how the code is really implemented and how the
FileSystemStorage class is implemented in the same file.
Change History (5)
comment:2 Changed 8 years ago by
|Patch needs improvement:||unset|
|Triage Stage:||Unreviewed → Accepted|