Commits

Anonymous committed 211aae4

added docstrings to all backends

Comments (0)

Files changed (4)

filetransfers/backends/default.py

 from django.utils.encoding import smart_str
 
 def prepare_upload(request, url):
+    """Directly uploads to the given URL"""
     return url
 
 def serve_file(request, file, save_as, content_type):
+    """
+    Serves the file in chunks for efficiency reasons, but the transfer still
+    goes through Django itself, so it's much worse than using the web server,
+    but at least it works with all configurations.
+    """
     response = HttpResponse(ChunkedFile(file), content_type=content_type)
     if save_as:
         response['Content-Disposition'] = smart_str(u'attachment; filename=%s' % save_as)

filetransfers/backends/redirect.py

 from django.utils.encoding import smart_str
 
 def serve_file(request, file, save_as, content_type):
+    """
+    Redirects downloads to a handler at settings.FILETRANSFERS_BASE_REDIRECT_URL
+    """
     return HttpResponseRedirect(smart_str(
         settings.FILETRANSFERS_BASE_REDIRECT_URL + file.name))

filetransfers/backends/url.py

 from django.utils.encoding import smart_str
 
 def serve_file(request, file, save_as, content_type):
+    """Serves files by redirecting to file.url (e.g., useful for Amazon S3)"""
     return HttpResponseRedirect(smart_str(file.url))

filetransfers/backends/xsendfile.py

 from django.utils.encoding import smart_str
 
 def serve_file(request, file, save_as, content_type):
+    """Lets the web server serve the file using the X-Sendfile extension"""
     response = HttpResponse(content_type=content_type)
     response['X-Sendfile'] = file.path
     if save_as:
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.